blob: 0ea4aef470e48d9f0d809adb7aa89f5469833db8 [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)
193 P('a', 'b', 'c')
194 P('/a', 'b', 'c')
195 P('a/b/c')
196 P('/a/b/c')
197 self.assertEqual(P(P('a')), P('a'))
198 self.assertEqual(P(P('a'), 'b'), P('a/b'))
199 self.assertEqual(P(P('a'), P('b')), P('a/b'))
200
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200201 def _check_str_subclass(self, *args):
202 # Issue #21127: it should be possible to construct a PurePath object
Serhiy Storchaka6a7b3a72016-04-17 08:32:47 +0300203 # from a str subclass instance, and it then gets converted to
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200204 # a pure str object.
205 class StrSubclass(str):
206 pass
207 P = self.cls
208 p = P(*(StrSubclass(x) for x in args))
209 self.assertEqual(p, P(*args))
210 for part in p.parts:
211 self.assertIs(type(part), str)
212
213 def test_str_subclass_common(self):
214 self._check_str_subclass('')
215 self._check_str_subclass('.')
216 self._check_str_subclass('a')
217 self._check_str_subclass('a/b.txt')
218 self._check_str_subclass('/a/b.txt')
219
Antoine Pitrou31119e42013-11-22 17:38:12 +0100220 def test_join_common(self):
221 P = self.cls
222 p = P('a/b')
223 pp = p.joinpath('c')
224 self.assertEqual(pp, P('a/b/c'))
225 self.assertIs(type(pp), type(p))
226 pp = p.joinpath('c', 'd')
227 self.assertEqual(pp, P('a/b/c/d'))
228 pp = p.joinpath(P('c'))
229 self.assertEqual(pp, P('a/b/c'))
230 pp = p.joinpath('/c')
231 self.assertEqual(pp, P('/c'))
232
233 def test_div_common(self):
234 # Basically the same as joinpath()
235 P = self.cls
236 p = P('a/b')
237 pp = p / 'c'
238 self.assertEqual(pp, P('a/b/c'))
239 self.assertIs(type(pp), type(p))
240 pp = p / 'c/d'
241 self.assertEqual(pp, P('a/b/c/d'))
242 pp = p / 'c' / 'd'
243 self.assertEqual(pp, P('a/b/c/d'))
244 pp = 'c' / p / 'd'
245 self.assertEqual(pp, P('c/a/b/d'))
246 pp = p / P('c')
247 self.assertEqual(pp, P('a/b/c'))
248 pp = p/ '/c'
249 self.assertEqual(pp, P('/c'))
250
251 def _check_str(self, expected, args):
252 p = self.cls(*args)
253 self.assertEqual(str(p), expected.replace('/', self.sep))
254
255 def test_str_common(self):
256 # Canonicalized paths roundtrip
257 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
258 self._check_str(pathstr, (pathstr,))
259 # Special case for the empty path
260 self._check_str('.', ('',))
261 # Other tests for str() are in test_equivalences()
262
263 def test_as_posix_common(self):
264 P = self.cls
265 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
266 self.assertEqual(P(pathstr).as_posix(), pathstr)
267 # Other tests for as_posix() are in test_equivalences()
268
269 def test_as_bytes_common(self):
270 sep = os.fsencode(self.sep)
271 P = self.cls
272 self.assertEqual(bytes(P('a/b')), b'a' + sep + b'b')
273
274 def test_as_uri_common(self):
275 P = self.cls
276 with self.assertRaises(ValueError):
277 P('a').as_uri()
278 with self.assertRaises(ValueError):
279 P().as_uri()
280
281 def test_repr_common(self):
282 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
283 p = self.cls(pathstr)
284 clsname = p.__class__.__name__
285 r = repr(p)
286 # The repr() is in the form ClassName("forward-slashes path")
287 self.assertTrue(r.startswith(clsname + '('), r)
288 self.assertTrue(r.endswith(')'), r)
289 inner = r[len(clsname) + 1 : -1]
290 self.assertEqual(eval(inner), p.as_posix())
291 # The repr() roundtrips
292 q = eval(r, pathlib.__dict__)
293 self.assertIs(q.__class__, p.__class__)
294 self.assertEqual(q, p)
295 self.assertEqual(repr(q), r)
296
297 def test_eq_common(self):
298 P = self.cls
299 self.assertEqual(P('a/b'), P('a/b'))
300 self.assertEqual(P('a/b'), P('a', 'b'))
301 self.assertNotEqual(P('a/b'), P('a'))
302 self.assertNotEqual(P('a/b'), P('/a/b'))
303 self.assertNotEqual(P('a/b'), P())
304 self.assertNotEqual(P('/a/b'), P('/'))
305 self.assertNotEqual(P(), P('/'))
306 self.assertNotEqual(P(), "")
307 self.assertNotEqual(P(), {})
308 self.assertNotEqual(P(), int)
309
310 def test_match_common(self):
311 P = self.cls
312 self.assertRaises(ValueError, P('a').match, '')
313 self.assertRaises(ValueError, P('a').match, '.')
314 # Simple relative pattern
315 self.assertTrue(P('b.py').match('b.py'))
316 self.assertTrue(P('a/b.py').match('b.py'))
317 self.assertTrue(P('/a/b.py').match('b.py'))
318 self.assertFalse(P('a.py').match('b.py'))
319 self.assertFalse(P('b/py').match('b.py'))
320 self.assertFalse(P('/a.py').match('b.py'))
321 self.assertFalse(P('b.py/c').match('b.py'))
322 # Wilcard relative pattern
323 self.assertTrue(P('b.py').match('*.py'))
324 self.assertTrue(P('a/b.py').match('*.py'))
325 self.assertTrue(P('/a/b.py').match('*.py'))
326 self.assertFalse(P('b.pyc').match('*.py'))
327 self.assertFalse(P('b./py').match('*.py'))
328 self.assertFalse(P('b.py/c').match('*.py'))
329 # Multi-part relative pattern
330 self.assertTrue(P('ab/c.py').match('a*/*.py'))
331 self.assertTrue(P('/d/ab/c.py').match('a*/*.py'))
332 self.assertFalse(P('a.py').match('a*/*.py'))
333 self.assertFalse(P('/dab/c.py').match('a*/*.py'))
334 self.assertFalse(P('ab/c.py/d').match('a*/*.py'))
335 # Absolute pattern
336 self.assertTrue(P('/b.py').match('/*.py'))
337 self.assertFalse(P('b.py').match('/*.py'))
338 self.assertFalse(P('a/b.py').match('/*.py'))
339 self.assertFalse(P('/a/b.py').match('/*.py'))
340 # Multi-part absolute pattern
341 self.assertTrue(P('/a/b.py').match('/a/*.py'))
342 self.assertFalse(P('/ab.py').match('/a/*.py'))
343 self.assertFalse(P('/a/b/c.py').match('/a/*.py'))
344
345 def test_ordering_common(self):
346 # Ordering is tuple-alike
347 def assertLess(a, b):
348 self.assertLess(a, b)
349 self.assertGreater(b, a)
350 P = self.cls
351 a = P('a')
352 b = P('a/b')
353 c = P('abc')
354 d = P('b')
355 assertLess(a, b)
356 assertLess(a, c)
357 assertLess(a, d)
358 assertLess(b, c)
359 assertLess(c, d)
360 P = self.cls
361 a = P('/a')
362 b = P('/a/b')
363 c = P('/abc')
364 d = P('/b')
365 assertLess(a, b)
366 assertLess(a, c)
367 assertLess(a, d)
368 assertLess(b, c)
369 assertLess(c, d)
370 with self.assertRaises(TypeError):
371 P() < {}
372
373 def test_parts_common(self):
374 # `parts` returns a tuple
375 sep = self.sep
376 P = self.cls
377 p = P('a/b')
378 parts = p.parts
379 self.assertEqual(parts, ('a', 'b'))
380 # The object gets reused
381 self.assertIs(parts, p.parts)
382 # When the path is absolute, the anchor is a separate part
383 p = P('/a/b')
384 parts = p.parts
385 self.assertEqual(parts, (sep, 'a', 'b'))
386
387 def test_equivalences(self):
388 for k, tuples in self.equivalences.items():
389 canon = k.replace('/', self.sep)
390 posix = k.replace(self.sep, '/')
391 if canon != posix:
392 tuples = tuples + [
393 tuple(part.replace('/', self.sep) for part in t)
394 for t in tuples
395 ]
396 tuples.append((posix, ))
397 pcanon = self.cls(canon)
398 for t in tuples:
399 p = self.cls(*t)
400 self.assertEqual(p, pcanon, "failed with args {}".format(t))
401 self.assertEqual(hash(p), hash(pcanon))
402 self.assertEqual(str(p), canon)
403 self.assertEqual(p.as_posix(), posix)
404
405 def test_parent_common(self):
406 # Relative
407 P = self.cls
408 p = P('a/b/c')
409 self.assertEqual(p.parent, P('a/b'))
410 self.assertEqual(p.parent.parent, P('a'))
411 self.assertEqual(p.parent.parent.parent, P())
412 self.assertEqual(p.parent.parent.parent.parent, P())
413 # Anchored
414 p = P('/a/b/c')
415 self.assertEqual(p.parent, P('/a/b'))
416 self.assertEqual(p.parent.parent, P('/a'))
417 self.assertEqual(p.parent.parent.parent, P('/'))
418 self.assertEqual(p.parent.parent.parent.parent, P('/'))
419
420 def test_parents_common(self):
421 # Relative
422 P = self.cls
423 p = P('a/b/c')
424 par = p.parents
425 self.assertEqual(len(par), 3)
426 self.assertEqual(par[0], P('a/b'))
427 self.assertEqual(par[1], P('a'))
428 self.assertEqual(par[2], P('.'))
429 self.assertEqual(list(par), [P('a/b'), P('a'), P('.')])
430 with self.assertRaises(IndexError):
431 par[-1]
432 with self.assertRaises(IndexError):
433 par[3]
434 with self.assertRaises(TypeError):
435 par[0] = p
436 # Anchored
437 p = P('/a/b/c')
438 par = p.parents
439 self.assertEqual(len(par), 3)
440 self.assertEqual(par[0], P('/a/b'))
441 self.assertEqual(par[1], P('/a'))
442 self.assertEqual(par[2], P('/'))
443 self.assertEqual(list(par), [P('/a/b'), P('/a'), P('/')])
444 with self.assertRaises(IndexError):
445 par[3]
446
447 def test_drive_common(self):
448 P = self.cls
449 self.assertEqual(P('a/b').drive, '')
450 self.assertEqual(P('/a/b').drive, '')
451 self.assertEqual(P('').drive, '')
452
453 def test_root_common(self):
454 P = self.cls
455 sep = self.sep
456 self.assertEqual(P('').root, '')
457 self.assertEqual(P('a/b').root, '')
458 self.assertEqual(P('/').root, sep)
459 self.assertEqual(P('/a/b').root, sep)
460
461 def test_anchor_common(self):
462 P = self.cls
463 sep = self.sep
464 self.assertEqual(P('').anchor, '')
465 self.assertEqual(P('a/b').anchor, '')
466 self.assertEqual(P('/').anchor, sep)
467 self.assertEqual(P('/a/b').anchor, sep)
468
469 def test_name_common(self):
470 P = self.cls
471 self.assertEqual(P('').name, '')
472 self.assertEqual(P('.').name, '')
473 self.assertEqual(P('/').name, '')
474 self.assertEqual(P('a/b').name, 'b')
475 self.assertEqual(P('/a/b').name, 'b')
476 self.assertEqual(P('/a/b/.').name, 'b')
477 self.assertEqual(P('a/b.py').name, 'b.py')
478 self.assertEqual(P('/a/b.py').name, 'b.py')
479
Guido van Rossume4282312016-01-06 11:01:42 -0800480 def test_path_common(self):
481 P = self.cls
482 def check(arg, expected=None):
483 if expected is None:
484 expected = arg
485 self.assertEqual(P(arg).path, expected.replace('/', self.sep))
486 check('', '.')
487 check('.')
488 check('/')
489 check('a/b')
490 check('/a/b')
491 check('/a/b/', '/a/b')
492 check('/a/b/.', '/a/b')
493 check('a/b.py')
494 check('/a/b.py')
495
Antoine Pitrou31119e42013-11-22 17:38:12 +0100496 def test_suffix_common(self):
497 P = self.cls
498 self.assertEqual(P('').suffix, '')
499 self.assertEqual(P('.').suffix, '')
500 self.assertEqual(P('..').suffix, '')
501 self.assertEqual(P('/').suffix, '')
502 self.assertEqual(P('a/b').suffix, '')
503 self.assertEqual(P('/a/b').suffix, '')
504 self.assertEqual(P('/a/b/.').suffix, '')
505 self.assertEqual(P('a/b.py').suffix, '.py')
506 self.assertEqual(P('/a/b.py').suffix, '.py')
507 self.assertEqual(P('a/.hgrc').suffix, '')
508 self.assertEqual(P('/a/.hgrc').suffix, '')
509 self.assertEqual(P('a/.hg.rc').suffix, '.rc')
510 self.assertEqual(P('/a/.hg.rc').suffix, '.rc')
511 self.assertEqual(P('a/b.tar.gz').suffix, '.gz')
512 self.assertEqual(P('/a/b.tar.gz').suffix, '.gz')
513 self.assertEqual(P('a/Some name. Ending with a dot.').suffix, '')
514 self.assertEqual(P('/a/Some name. Ending with a dot.').suffix, '')
515
516 def test_suffixes_common(self):
517 P = self.cls
518 self.assertEqual(P('').suffixes, [])
519 self.assertEqual(P('.').suffixes, [])
520 self.assertEqual(P('/').suffixes, [])
521 self.assertEqual(P('a/b').suffixes, [])
522 self.assertEqual(P('/a/b').suffixes, [])
523 self.assertEqual(P('/a/b/.').suffixes, [])
524 self.assertEqual(P('a/b.py').suffixes, ['.py'])
525 self.assertEqual(P('/a/b.py').suffixes, ['.py'])
526 self.assertEqual(P('a/.hgrc').suffixes, [])
527 self.assertEqual(P('/a/.hgrc').suffixes, [])
528 self.assertEqual(P('a/.hg.rc').suffixes, ['.rc'])
529 self.assertEqual(P('/a/.hg.rc').suffixes, ['.rc'])
530 self.assertEqual(P('a/b.tar.gz').suffixes, ['.tar', '.gz'])
531 self.assertEqual(P('/a/b.tar.gz').suffixes, ['.tar', '.gz'])
532 self.assertEqual(P('a/Some name. Ending with a dot.').suffixes, [])
533 self.assertEqual(P('/a/Some name. Ending with a dot.').suffixes, [])
534
535 def test_stem_common(self):
536 P = self.cls
537 self.assertEqual(P('').stem, '')
538 self.assertEqual(P('.').stem, '')
539 self.assertEqual(P('..').stem, '..')
540 self.assertEqual(P('/').stem, '')
541 self.assertEqual(P('a/b').stem, 'b')
542 self.assertEqual(P('a/b.py').stem, 'b')
543 self.assertEqual(P('a/.hgrc').stem, '.hgrc')
544 self.assertEqual(P('a/.hg.rc').stem, '.hg')
545 self.assertEqual(P('a/b.tar.gz').stem, 'b.tar')
546 self.assertEqual(P('a/Some name. Ending with a dot.').stem,
547 'Some name. Ending with a dot.')
548
549 def test_with_name_common(self):
550 P = self.cls
551 self.assertEqual(P('a/b').with_name('d.xml'), P('a/d.xml'))
552 self.assertEqual(P('/a/b').with_name('d.xml'), P('/a/d.xml'))
553 self.assertEqual(P('a/b.py').with_name('d.xml'), P('a/d.xml'))
554 self.assertEqual(P('/a/b.py').with_name('d.xml'), P('/a/d.xml'))
555 self.assertEqual(P('a/Dot ending.').with_name('d.xml'), P('a/d.xml'))
556 self.assertEqual(P('/a/Dot ending.').with_name('d.xml'), P('/a/d.xml'))
557 self.assertRaises(ValueError, P('').with_name, 'd.xml')
558 self.assertRaises(ValueError, P('.').with_name, 'd.xml')
559 self.assertRaises(ValueError, P('/').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400560 self.assertRaises(ValueError, P('a/b').with_name, '')
561 self.assertRaises(ValueError, P('a/b').with_name, '/c')
562 self.assertRaises(ValueError, P('a/b').with_name, 'c/')
563 self.assertRaises(ValueError, P('a/b').with_name, 'c/d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100564
565 def test_with_suffix_common(self):
566 P = self.cls
567 self.assertEqual(P('a/b').with_suffix('.gz'), P('a/b.gz'))
568 self.assertEqual(P('/a/b').with_suffix('.gz'), P('/a/b.gz'))
569 self.assertEqual(P('a/b.py').with_suffix('.gz'), P('a/b.gz'))
570 self.assertEqual(P('/a/b.py').with_suffix('.gz'), P('/a/b.gz'))
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400571 # Stripping suffix
572 self.assertEqual(P('a/b.py').with_suffix(''), P('a/b'))
573 self.assertEqual(P('/a/b').with_suffix(''), P('/a/b'))
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100574 # Path doesn't have a "filename" component
Antoine Pitrou31119e42013-11-22 17:38:12 +0100575 self.assertRaises(ValueError, P('').with_suffix, '.gz')
576 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
577 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100578 # Invalid suffix
579 self.assertRaises(ValueError, P('a/b').with_suffix, 'gz')
580 self.assertRaises(ValueError, P('a/b').with_suffix, '/')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400581 self.assertRaises(ValueError, P('a/b').with_suffix, '.')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100582 self.assertRaises(ValueError, P('a/b').with_suffix, '/.gz')
583 self.assertRaises(ValueError, P('a/b').with_suffix, 'c/d')
584 self.assertRaises(ValueError, P('a/b').with_suffix, '.c/.d')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400585 self.assertRaises(ValueError, P('a/b').with_suffix, './.d')
586 self.assertRaises(ValueError, P('a/b').with_suffix, '.d/.')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100587
588 def test_relative_to_common(self):
589 P = self.cls
590 p = P('a/b')
591 self.assertRaises(TypeError, p.relative_to)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100592 self.assertRaises(TypeError, p.relative_to, b'a')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100593 self.assertEqual(p.relative_to(P()), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100594 self.assertEqual(p.relative_to(''), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100595 self.assertEqual(p.relative_to(P('a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100596 self.assertEqual(p.relative_to('a'), P('b'))
597 self.assertEqual(p.relative_to('a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100598 self.assertEqual(p.relative_to(P('a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100599 self.assertEqual(p.relative_to('a/b'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +0100600 # With several args
601 self.assertEqual(p.relative_to('a', 'b'), P())
602 # Unrelated paths
603 self.assertRaises(ValueError, p.relative_to, P('c'))
604 self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
605 self.assertRaises(ValueError, p.relative_to, P('a/c'))
606 self.assertRaises(ValueError, p.relative_to, P('/a'))
607 p = P('/a/b')
608 self.assertEqual(p.relative_to(P('/')), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100609 self.assertEqual(p.relative_to('/'), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100610 self.assertEqual(p.relative_to(P('/a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100611 self.assertEqual(p.relative_to('/a'), P('b'))
612 self.assertEqual(p.relative_to('/a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100613 self.assertEqual(p.relative_to(P('/a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100614 self.assertEqual(p.relative_to('/a/b'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +0100615 # Unrelated paths
616 self.assertRaises(ValueError, p.relative_to, P('/c'))
617 self.assertRaises(ValueError, p.relative_to, P('/a/b/c'))
618 self.assertRaises(ValueError, p.relative_to, P('/a/c'))
619 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100620 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100621 self.assertRaises(ValueError, p.relative_to, P('a'))
622
623 def test_pickling_common(self):
624 P = self.cls
625 p = P('/a/b')
626 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
627 dumped = pickle.dumps(p, proto)
628 pp = pickle.loads(dumped)
629 self.assertIs(pp.__class__, p.__class__)
630 self.assertEqual(pp, p)
631 self.assertEqual(hash(pp), hash(p))
632 self.assertEqual(str(pp), str(p))
633
634
635class PurePosixPathTest(_BasePurePathTest, unittest.TestCase):
636 cls = pathlib.PurePosixPath
637
638 def test_root(self):
639 P = self.cls
640 self.assertEqual(P('/a/b').root, '/')
641 self.assertEqual(P('///a/b').root, '/')
642 # POSIX special case for two leading slashes
643 self.assertEqual(P('//a/b').root, '//')
644
645 def test_eq(self):
646 P = self.cls
647 self.assertNotEqual(P('a/b'), P('A/b'))
648 self.assertEqual(P('/a'), P('///a'))
649 self.assertNotEqual(P('/a'), P('//a'))
650
651 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100652 P = self.cls
653 self.assertEqual(P('/').as_uri(), 'file:///')
654 self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')
655 self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')
Antoine Pitrou29eac422013-11-22 17:57:03 +0100656
657 def test_as_uri_non_ascii(self):
658 from urllib.parse import quote_from_bytes
659 P = self.cls
660 try:
661 os.fsencode('\xe9')
662 except UnicodeEncodeError:
663 self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")
Antoine Pitrou31119e42013-11-22 17:38:12 +0100664 self.assertEqual(P('/a/b\xe9').as_uri(),
665 'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))
666
667 def test_match(self):
668 P = self.cls
669 self.assertFalse(P('A.py').match('a.PY'))
670
671 def test_is_absolute(self):
672 P = self.cls
673 self.assertFalse(P().is_absolute())
674 self.assertFalse(P('a').is_absolute())
675 self.assertFalse(P('a/b/').is_absolute())
676 self.assertTrue(P('/').is_absolute())
677 self.assertTrue(P('/a').is_absolute())
678 self.assertTrue(P('/a/b/').is_absolute())
679 self.assertTrue(P('//a').is_absolute())
680 self.assertTrue(P('//a/b').is_absolute())
681
682 def test_is_reserved(self):
683 P = self.cls
684 self.assertIs(False, P('').is_reserved())
685 self.assertIs(False, P('/').is_reserved())
686 self.assertIs(False, P('/foo/bar').is_reserved())
687 self.assertIs(False, P('/dev/con/PRN/NUL').is_reserved())
688
689 def test_join(self):
690 P = self.cls
691 p = P('//a')
692 pp = p.joinpath('b')
693 self.assertEqual(pp, P('//a/b'))
694 pp = P('/a').joinpath('//c')
695 self.assertEqual(pp, P('//c'))
696 pp = P('//a').joinpath('/c')
697 self.assertEqual(pp, P('/c'))
698
699 def test_div(self):
700 # Basically the same as joinpath()
701 P = self.cls
702 p = P('//a')
703 pp = p / 'b'
704 self.assertEqual(pp, P('//a/b'))
705 pp = P('/a') / '//c'
706 self.assertEqual(pp, P('//c'))
707 pp = P('//a') / '/c'
708 self.assertEqual(pp, P('/c'))
709
710
711class PureWindowsPathTest(_BasePurePathTest, unittest.TestCase):
712 cls = pathlib.PureWindowsPath
713
714 equivalences = _BasePurePathTest.equivalences.copy()
715 equivalences.update({
716 'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('/', 'c:', 'a') ],
717 'c:/a': [
718 ('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),
719 ('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),
720 ],
721 '//a/b/': [ ('//a/b',) ],
722 '//a/b/c': [
723 ('//a/b', 'c'), ('//a/b/', 'c'),
724 ],
725 })
726
727 def test_str(self):
728 p = self.cls('a/b/c')
729 self.assertEqual(str(p), 'a\\b\\c')
730 p = self.cls('c:/a/b/c')
731 self.assertEqual(str(p), 'c:\\a\\b\\c')
732 p = self.cls('//a/b')
733 self.assertEqual(str(p), '\\\\a\\b\\')
734 p = self.cls('//a/b/c')
735 self.assertEqual(str(p), '\\\\a\\b\\c')
736 p = self.cls('//a/b/c/d')
737 self.assertEqual(str(p), '\\\\a\\b\\c\\d')
738
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200739 def test_str_subclass(self):
740 self._check_str_subclass('c:')
741 self._check_str_subclass('c:a')
742 self._check_str_subclass('c:a\\b.txt')
743 self._check_str_subclass('c:\\')
744 self._check_str_subclass('c:\\a')
745 self._check_str_subclass('c:\\a\\b.txt')
746 self._check_str_subclass('\\\\some\\share')
747 self._check_str_subclass('\\\\some\\share\\a')
748 self._check_str_subclass('\\\\some\\share\\a\\b.txt')
749
Antoine Pitrou31119e42013-11-22 17:38:12 +0100750 def test_eq(self):
751 P = self.cls
752 self.assertEqual(P('c:a/b'), P('c:a/b'))
753 self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))
754 self.assertNotEqual(P('c:a/b'), P('d:a/b'))
755 self.assertNotEqual(P('c:a/b'), P('c:/a/b'))
756 self.assertNotEqual(P('/a/b'), P('c:/a/b'))
757 # Case-insensitivity
758 self.assertEqual(P('a/B'), P('A/b'))
759 self.assertEqual(P('C:a/B'), P('c:A/b'))
760 self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))
761
762 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100763 P = self.cls
764 with self.assertRaises(ValueError):
765 P('/a/b').as_uri()
766 with self.assertRaises(ValueError):
767 P('c:a/b').as_uri()
768 self.assertEqual(P('c:/').as_uri(), 'file:///c:/')
769 self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')
770 self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')
771 self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')
772 self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')
773 self.assertEqual(P('//some/share/a/b.c').as_uri(),
774 'file://some/share/a/b.c')
775 self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),
776 'file://some/share/a/b%25%23c%C3%A9')
777
778 def test_match_common(self):
779 P = self.cls
780 # Absolute patterns
781 self.assertTrue(P('c:/b.py').match('/*.py'))
782 self.assertTrue(P('c:/b.py').match('c:*.py'))
783 self.assertTrue(P('c:/b.py').match('c:/*.py'))
784 self.assertFalse(P('d:/b.py').match('c:/*.py')) # wrong drive
785 self.assertFalse(P('b.py').match('/*.py'))
786 self.assertFalse(P('b.py').match('c:*.py'))
787 self.assertFalse(P('b.py').match('c:/*.py'))
788 self.assertFalse(P('c:b.py').match('/*.py'))
789 self.assertFalse(P('c:b.py').match('c:/*.py'))
790 self.assertFalse(P('/b.py').match('c:*.py'))
791 self.assertFalse(P('/b.py').match('c:/*.py'))
792 # UNC patterns
793 self.assertTrue(P('//some/share/a.py').match('/*.py'))
794 self.assertTrue(P('//some/share/a.py').match('//some/share/*.py'))
795 self.assertFalse(P('//other/share/a.py').match('//some/share/*.py'))
796 self.assertFalse(P('//some/share/a/b.py').match('//some/share/*.py'))
797 # Case-insensitivity
798 self.assertTrue(P('B.py').match('b.PY'))
799 self.assertTrue(P('c:/a/B.Py').match('C:/A/*.pY'))
800 self.assertTrue(P('//Some/Share/B.Py').match('//somE/sharE/*.pY'))
801
802 def test_ordering_common(self):
803 # Case-insensitivity
804 def assertOrderedEqual(a, b):
805 self.assertLessEqual(a, b)
806 self.assertGreaterEqual(b, a)
807 P = self.cls
808 p = P('c:A/b')
809 q = P('C:a/B')
810 assertOrderedEqual(p, q)
811 self.assertFalse(p < q)
812 self.assertFalse(p > q)
813 p = P('//some/Share/A/b')
814 q = P('//Some/SHARE/a/B')
815 assertOrderedEqual(p, q)
816 self.assertFalse(p < q)
817 self.assertFalse(p > q)
818
819 def test_parts(self):
820 P = self.cls
821 p = P('c:a/b')
822 parts = p.parts
823 self.assertEqual(parts, ('c:', 'a', 'b'))
824 p = P('c:/a/b')
825 parts = p.parts
826 self.assertEqual(parts, ('c:\\', 'a', 'b'))
827 p = P('//a/b/c/d')
828 parts = p.parts
829 self.assertEqual(parts, ('\\\\a\\b\\', 'c', 'd'))
830
831 def test_parent(self):
832 # Anchored
833 P = self.cls
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('z:/a/b/c')
840 self.assertEqual(p.parent, P('z:/a/b'))
841 self.assertEqual(p.parent.parent, P('z:/a'))
842 self.assertEqual(p.parent.parent.parent, P('z:/'))
843 self.assertEqual(p.parent.parent.parent.parent, P('z:/'))
844 p = P('//a/b/c/d')
845 self.assertEqual(p.parent, P('//a/b/c'))
846 self.assertEqual(p.parent.parent, P('//a/b'))
847 self.assertEqual(p.parent.parent.parent, P('//a/b'))
848
849 def test_parents(self):
850 # Anchored
851 P = self.cls
852 p = P('z:a/b/')
853 par = p.parents
854 self.assertEqual(len(par), 2)
855 self.assertEqual(par[0], P('z:a'))
856 self.assertEqual(par[1], P('z:'))
857 self.assertEqual(list(par), [P('z:a'), P('z:')])
858 with self.assertRaises(IndexError):
859 par[2]
860 p = P('z:/a/b/')
861 par = p.parents
862 self.assertEqual(len(par), 2)
863 self.assertEqual(par[0], P('z:/a'))
864 self.assertEqual(par[1], P('z:/'))
865 self.assertEqual(list(par), [P('z:/a'), P('z:/')])
866 with self.assertRaises(IndexError):
867 par[2]
868 p = P('//a/b/c/d')
869 par = p.parents
870 self.assertEqual(len(par), 2)
871 self.assertEqual(par[0], P('//a/b/c'))
872 self.assertEqual(par[1], P('//a/b'))
873 self.assertEqual(list(par), [P('//a/b/c'), P('//a/b')])
874 with self.assertRaises(IndexError):
875 par[2]
876
877 def test_drive(self):
878 P = self.cls
879 self.assertEqual(P('c:').drive, 'c:')
880 self.assertEqual(P('c:a/b').drive, 'c:')
881 self.assertEqual(P('c:/').drive, 'c:')
882 self.assertEqual(P('c:/a/b/').drive, 'c:')
883 self.assertEqual(P('//a/b').drive, '\\\\a\\b')
884 self.assertEqual(P('//a/b/').drive, '\\\\a\\b')
885 self.assertEqual(P('//a/b/c/d').drive, '\\\\a\\b')
886
887 def test_root(self):
888 P = self.cls
889 self.assertEqual(P('c:').root, '')
890 self.assertEqual(P('c:a/b').root, '')
891 self.assertEqual(P('c:/').root, '\\')
892 self.assertEqual(P('c:/a/b/').root, '\\')
893 self.assertEqual(P('//a/b').root, '\\')
894 self.assertEqual(P('//a/b/').root, '\\')
895 self.assertEqual(P('//a/b/c/d').root, '\\')
896
897 def test_anchor(self):
898 P = self.cls
899 self.assertEqual(P('c:').anchor, 'c:')
900 self.assertEqual(P('c:a/b').anchor, 'c:')
901 self.assertEqual(P('c:/').anchor, 'c:\\')
902 self.assertEqual(P('c:/a/b/').anchor, 'c:\\')
903 self.assertEqual(P('//a/b').anchor, '\\\\a\\b\\')
904 self.assertEqual(P('//a/b/').anchor, '\\\\a\\b\\')
905 self.assertEqual(P('//a/b/c/d').anchor, '\\\\a\\b\\')
906
907 def test_name(self):
908 P = self.cls
909 self.assertEqual(P('c:').name, '')
910 self.assertEqual(P('c:/').name, '')
911 self.assertEqual(P('c:a/b').name, 'b')
912 self.assertEqual(P('c:/a/b').name, 'b')
913 self.assertEqual(P('c:a/b.py').name, 'b.py')
914 self.assertEqual(P('c:/a/b.py').name, 'b.py')
915 self.assertEqual(P('//My.py/Share.php').name, '')
916 self.assertEqual(P('//My.py/Share.php/a/b').name, 'b')
917
Guido van Rossume4282312016-01-06 11:01:42 -0800918 def test_path(self):
919 P = self.cls
920 self.assertEqual(P('c:').path, 'c:')
921 self.assertEqual(P('c:/').path, 'c:\\')
922 self.assertEqual(P('c:a/b').path, 'c:a\\b')
923 self.assertEqual(P('c:/a/b').path, 'c:\\a\\b')
924 self.assertEqual(P('c:a/b.py').path, 'c:a\\b.py')
925 self.assertEqual(P('c:/a/b.py').path, 'c:\\a\\b.py')
926 self.assertEqual(P('//My.py/Share.php').path, '\\\\My.py\\Share.php\\')
927 self.assertEqual(P('//My.py/Share.php/a/b').path, '\\\\My.py\\Share.php\\a\\b')
928
Antoine Pitrou31119e42013-11-22 17:38:12 +0100929 def test_suffix(self):
930 P = self.cls
931 self.assertEqual(P('c:').suffix, '')
932 self.assertEqual(P('c:/').suffix, '')
933 self.assertEqual(P('c:a/b').suffix, '')
934 self.assertEqual(P('c:/a/b').suffix, '')
935 self.assertEqual(P('c:a/b.py').suffix, '.py')
936 self.assertEqual(P('c:/a/b.py').suffix, '.py')
937 self.assertEqual(P('c:a/.hgrc').suffix, '')
938 self.assertEqual(P('c:/a/.hgrc').suffix, '')
939 self.assertEqual(P('c:a/.hg.rc').suffix, '.rc')
940 self.assertEqual(P('c:/a/.hg.rc').suffix, '.rc')
941 self.assertEqual(P('c:a/b.tar.gz').suffix, '.gz')
942 self.assertEqual(P('c:/a/b.tar.gz').suffix, '.gz')
943 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffix, '')
944 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffix, '')
945 self.assertEqual(P('//My.py/Share.php').suffix, '')
946 self.assertEqual(P('//My.py/Share.php/a/b').suffix, '')
947
948 def test_suffixes(self):
949 P = self.cls
950 self.assertEqual(P('c:').suffixes, [])
951 self.assertEqual(P('c:/').suffixes, [])
952 self.assertEqual(P('c:a/b').suffixes, [])
953 self.assertEqual(P('c:/a/b').suffixes, [])
954 self.assertEqual(P('c:a/b.py').suffixes, ['.py'])
955 self.assertEqual(P('c:/a/b.py').suffixes, ['.py'])
956 self.assertEqual(P('c:a/.hgrc').suffixes, [])
957 self.assertEqual(P('c:/a/.hgrc').suffixes, [])
958 self.assertEqual(P('c:a/.hg.rc').suffixes, ['.rc'])
959 self.assertEqual(P('c:/a/.hg.rc').suffixes, ['.rc'])
960 self.assertEqual(P('c:a/b.tar.gz').suffixes, ['.tar', '.gz'])
961 self.assertEqual(P('c:/a/b.tar.gz').suffixes, ['.tar', '.gz'])
962 self.assertEqual(P('//My.py/Share.php').suffixes, [])
963 self.assertEqual(P('//My.py/Share.php/a/b').suffixes, [])
964 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffixes, [])
965 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffixes, [])
966
967 def test_stem(self):
968 P = self.cls
969 self.assertEqual(P('c:').stem, '')
970 self.assertEqual(P('c:.').stem, '')
971 self.assertEqual(P('c:..').stem, '..')
972 self.assertEqual(P('c:/').stem, '')
973 self.assertEqual(P('c:a/b').stem, 'b')
974 self.assertEqual(P('c:a/b.py').stem, 'b')
975 self.assertEqual(P('c:a/.hgrc').stem, '.hgrc')
976 self.assertEqual(P('c:a/.hg.rc').stem, '.hg')
977 self.assertEqual(P('c:a/b.tar.gz').stem, 'b.tar')
978 self.assertEqual(P('c:a/Some name. Ending with a dot.').stem,
979 'Some name. Ending with a dot.')
980
981 def test_with_name(self):
982 P = self.cls
983 self.assertEqual(P('c:a/b').with_name('d.xml'), P('c:a/d.xml'))
984 self.assertEqual(P('c:/a/b').with_name('d.xml'), P('c:/a/d.xml'))
985 self.assertEqual(P('c:a/Dot ending.').with_name('d.xml'), P('c:a/d.xml'))
986 self.assertEqual(P('c:/a/Dot ending.').with_name('d.xml'), P('c:/a/d.xml'))
987 self.assertRaises(ValueError, P('c:').with_name, 'd.xml')
988 self.assertRaises(ValueError, P('c:/').with_name, 'd.xml')
989 self.assertRaises(ValueError, P('//My/Share').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400990 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:')
991 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:e')
992 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:/e')
993 self.assertRaises(ValueError, P('c:a/b').with_name, '//My/Share')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100994
995 def test_with_suffix(self):
996 P = self.cls
997 self.assertEqual(P('c:a/b').with_suffix('.gz'), P('c:a/b.gz'))
998 self.assertEqual(P('c:/a/b').with_suffix('.gz'), P('c:/a/b.gz'))
999 self.assertEqual(P('c:a/b.py').with_suffix('.gz'), P('c:a/b.gz'))
1000 self.assertEqual(P('c:/a/b.py').with_suffix('.gz'), P('c:/a/b.gz'))
Antoine Pitrou1b02da92014-01-03 00:07:17 +01001001 # Path doesn't have a "filename" component
Antoine Pitrou31119e42013-11-22 17:38:12 +01001002 self.assertRaises(ValueError, P('').with_suffix, '.gz')
1003 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
1004 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
1005 self.assertRaises(ValueError, P('//My/Share').with_suffix, '.gz')
Antoine Pitrou1b02da92014-01-03 00:07:17 +01001006 # Invalid suffix
1007 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'gz')
1008 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/')
1009 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\')
1010 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:')
1011 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/.gz')
1012 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\.gz')
1013 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:.gz')
1014 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c/d')
1015 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c\\d')
1016 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c/d')
1017 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c\\d')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001018
1019 def test_relative_to(self):
1020 P = self.cls
Antoine Pitrou156b3612013-12-28 19:49:04 +01001021 p = P('C:Foo/Bar')
1022 self.assertEqual(p.relative_to(P('c:')), P('Foo/Bar'))
1023 self.assertEqual(p.relative_to('c:'), P('Foo/Bar'))
1024 self.assertEqual(p.relative_to(P('c:foO')), P('Bar'))
1025 self.assertEqual(p.relative_to('c:foO'), P('Bar'))
1026 self.assertEqual(p.relative_to('c:foO/'), P('Bar'))
1027 self.assertEqual(p.relative_to(P('c:foO/baR')), P())
1028 self.assertEqual(p.relative_to('c:foO/baR'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001029 # Unrelated paths
1030 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +01001031 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001032 self.assertRaises(ValueError, p.relative_to, P('d:'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001033 self.assertRaises(ValueError, p.relative_to, P('/'))
1034 self.assertRaises(ValueError, p.relative_to, P('Foo'))
1035 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1036 self.assertRaises(ValueError, p.relative_to, P('C:/Foo'))
1037 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Bar/Baz'))
1038 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Baz'))
1039 p = P('C:/Foo/Bar')
1040 self.assertEqual(p.relative_to(P('c:')), P('/Foo/Bar'))
1041 self.assertEqual(p.relative_to('c:'), P('/Foo/Bar'))
1042 self.assertEqual(str(p.relative_to(P('c:'))), '\\Foo\\Bar')
1043 self.assertEqual(str(p.relative_to('c:')), '\\Foo\\Bar')
1044 self.assertEqual(p.relative_to(P('c:/')), P('Foo/Bar'))
1045 self.assertEqual(p.relative_to('c:/'), P('Foo/Bar'))
1046 self.assertEqual(p.relative_to(P('c:/foO')), P('Bar'))
1047 self.assertEqual(p.relative_to('c:/foO'), P('Bar'))
1048 self.assertEqual(p.relative_to('c:/foO/'), P('Bar'))
1049 self.assertEqual(p.relative_to(P('c:/foO/baR')), P())
1050 self.assertEqual(p.relative_to('c:/foO/baR'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001051 # Unrelated paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001052 self.assertRaises(ValueError, p.relative_to, P('C:/Baz'))
1053 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Bar/Baz'))
1054 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Baz'))
1055 self.assertRaises(ValueError, p.relative_to, P('C:Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001056 self.assertRaises(ValueError, p.relative_to, P('d:'))
1057 self.assertRaises(ValueError, p.relative_to, P('d:/'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001058 self.assertRaises(ValueError, p.relative_to, P('/'))
1059 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1060 self.assertRaises(ValueError, p.relative_to, P('//C/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001061 # UNC paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001062 p = P('//Server/Share/Foo/Bar')
1063 self.assertEqual(p.relative_to(P('//sErver/sHare')), P('Foo/Bar'))
1064 self.assertEqual(p.relative_to('//sErver/sHare'), P('Foo/Bar'))
1065 self.assertEqual(p.relative_to('//sErver/sHare/'), P('Foo/Bar'))
1066 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo')), P('Bar'))
1067 self.assertEqual(p.relative_to('//sErver/sHare/Foo'), P('Bar'))
1068 self.assertEqual(p.relative_to('//sErver/sHare/Foo/'), P('Bar'))
1069 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo/Bar')), P())
1070 self.assertEqual(p.relative_to('//sErver/sHare/Foo/Bar'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001071 # Unrelated paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001072 self.assertRaises(ValueError, p.relative_to, P('/Server/Share/Foo'))
1073 self.assertRaises(ValueError, p.relative_to, P('c:/Server/Share/Foo'))
1074 self.assertRaises(ValueError, p.relative_to, P('//z/Share/Foo'))
1075 self.assertRaises(ValueError, p.relative_to, P('//Server/z/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001076
1077 def test_is_absolute(self):
1078 P = self.cls
1079 # Under NT, only paths with both a drive and a root are absolute
1080 self.assertFalse(P().is_absolute())
1081 self.assertFalse(P('a').is_absolute())
1082 self.assertFalse(P('a/b/').is_absolute())
1083 self.assertFalse(P('/').is_absolute())
1084 self.assertFalse(P('/a').is_absolute())
1085 self.assertFalse(P('/a/b/').is_absolute())
1086 self.assertFalse(P('c:').is_absolute())
1087 self.assertFalse(P('c:a').is_absolute())
1088 self.assertFalse(P('c:a/b/').is_absolute())
1089 self.assertTrue(P('c:/').is_absolute())
1090 self.assertTrue(P('c:/a').is_absolute())
1091 self.assertTrue(P('c:/a/b/').is_absolute())
1092 # UNC paths are absolute by definition
1093 self.assertTrue(P('//a/b').is_absolute())
1094 self.assertTrue(P('//a/b/').is_absolute())
1095 self.assertTrue(P('//a/b/c').is_absolute())
1096 self.assertTrue(P('//a/b/c/d').is_absolute())
1097
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001098 def test_join(self):
1099 P = self.cls
1100 p = P('C:/a/b')
1101 pp = p.joinpath('x/y')
1102 self.assertEqual(pp, P('C:/a/b/x/y'))
1103 pp = p.joinpath('/x/y')
1104 self.assertEqual(pp, P('C:/x/y'))
1105 # Joining with a different drive => the first path is ignored, even
1106 # if the second path is relative.
1107 pp = p.joinpath('D:x/y')
1108 self.assertEqual(pp, P('D:x/y'))
1109 pp = p.joinpath('D:/x/y')
1110 self.assertEqual(pp, P('D:/x/y'))
1111 pp = p.joinpath('//host/share/x/y')
1112 self.assertEqual(pp, P('//host/share/x/y'))
1113 # Joining with the same drive => the first path is appended to if
1114 # the second path is relative.
1115 pp = p.joinpath('c:x/y')
1116 self.assertEqual(pp, P('C:/a/b/x/y'))
1117 pp = p.joinpath('c:/x/y')
1118 self.assertEqual(pp, P('C:/x/y'))
1119
1120 def test_div(self):
1121 # Basically the same as joinpath()
1122 P = self.cls
1123 p = P('C:/a/b')
1124 self.assertEqual(p / 'x/y', P('C:/a/b/x/y'))
1125 self.assertEqual(p / 'x' / 'y', P('C:/a/b/x/y'))
1126 self.assertEqual(p / '/x/y', P('C:/x/y'))
1127 self.assertEqual(p / '/x' / 'y', P('C:/x/y'))
1128 # Joining with a different drive => the first path is ignored, even
1129 # if the second path is relative.
1130 self.assertEqual(p / 'D:x/y', P('D:x/y'))
1131 self.assertEqual(p / 'D:' / 'x/y', P('D:x/y'))
1132 self.assertEqual(p / 'D:/x/y', P('D:/x/y'))
1133 self.assertEqual(p / 'D:' / '/x/y', P('D:/x/y'))
1134 self.assertEqual(p / '//host/share/x/y', P('//host/share/x/y'))
1135 # Joining with the same drive => the first path is appended to if
1136 # the second path is relative.
Serhiy Storchaka010ff582013-12-06 17:25:51 +02001137 self.assertEqual(p / 'c:x/y', P('C:/a/b/x/y'))
1138 self.assertEqual(p / 'c:/x/y', P('C:/x/y'))
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001139
Antoine Pitrou31119e42013-11-22 17:38:12 +01001140 def test_is_reserved(self):
1141 P = self.cls
1142 self.assertIs(False, P('').is_reserved())
1143 self.assertIs(False, P('/').is_reserved())
1144 self.assertIs(False, P('/foo/bar').is_reserved())
1145 self.assertIs(True, P('con').is_reserved())
1146 self.assertIs(True, P('NUL').is_reserved())
1147 self.assertIs(True, P('NUL.txt').is_reserved())
1148 self.assertIs(True, P('com1').is_reserved())
1149 self.assertIs(True, P('com9.bar').is_reserved())
1150 self.assertIs(False, P('bar.com9').is_reserved())
1151 self.assertIs(True, P('lpt1').is_reserved())
1152 self.assertIs(True, P('lpt9.bar').is_reserved())
1153 self.assertIs(False, P('bar.lpt9').is_reserved())
1154 # Only the last component matters
1155 self.assertIs(False, P('c:/NUL/con/baz').is_reserved())
1156 # UNC paths are never reserved
1157 self.assertIs(False, P('//my/share/nul/con/aux').is_reserved())
1158
Antoine Pitrou31119e42013-11-22 17:38:12 +01001159class PurePathTest(_BasePurePathTest, unittest.TestCase):
1160 cls = pathlib.PurePath
1161
1162 def test_concrete_class(self):
1163 p = self.cls('a')
1164 self.assertIs(type(p),
1165 pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath)
1166
1167 def test_different_flavours_unequal(self):
1168 p = pathlib.PurePosixPath('a')
1169 q = pathlib.PureWindowsPath('a')
1170 self.assertNotEqual(p, q)
1171
1172 def test_different_flavours_unordered(self):
1173 p = pathlib.PurePosixPath('a')
1174 q = pathlib.PureWindowsPath('a')
1175 with self.assertRaises(TypeError):
1176 p < q
1177 with self.assertRaises(TypeError):
1178 p <= q
1179 with self.assertRaises(TypeError):
1180 p > q
1181 with self.assertRaises(TypeError):
1182 p >= q
1183
1184
1185#
1186# Tests for the concrete classes
1187#
1188
1189# Make sure any symbolic links in the base test path are resolved
1190BASE = os.path.realpath(TESTFN)
1191join = lambda *x: os.path.join(BASE, *x)
1192rel_join = lambda *x: os.path.join(TESTFN, *x)
1193
1194def symlink_skip_reason():
1195 if not pathlib.supports_symlinks:
1196 return "no system support for symlinks"
1197 try:
1198 os.symlink(__file__, BASE)
1199 except OSError as e:
1200 return str(e)
1201 else:
1202 support.unlink(BASE)
1203 return None
1204
1205symlink_skip_reason = symlink_skip_reason()
1206
1207only_nt = unittest.skipIf(os.name != 'nt',
1208 'test requires a Windows-compatible system')
1209only_posix = unittest.skipIf(os.name == 'nt',
1210 'test requires a POSIX-compatible system')
1211with_symlinks = unittest.skipIf(symlink_skip_reason, symlink_skip_reason)
1212
1213
1214@only_posix
1215class PosixPathAsPureTest(PurePosixPathTest):
1216 cls = pathlib.PosixPath
1217
1218@only_nt
1219class WindowsPathAsPureTest(PureWindowsPathTest):
1220 cls = pathlib.WindowsPath
1221
Victor Stinnerd7569632016-03-11 22:53:00 +01001222 def test_owner(self):
1223 P = self.cls
1224 with self.assertRaises(NotImplementedError):
1225 P('c:/').owner()
1226
1227 def test_group(self):
1228 P = self.cls
1229 with self.assertRaises(NotImplementedError):
1230 P('c:/').group()
1231
Antoine Pitrou31119e42013-11-22 17:38:12 +01001232
1233class _BasePathTest(object):
1234 """Tests for the FS-accessing functionalities of the Path classes."""
1235
1236 # (BASE)
1237 # |
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001238 # |-- brokenLink -> non-existing
1239 # |-- dirA
1240 # | `-- linkC -> ../dirB
1241 # |-- dirB
1242 # | |-- fileB
1243 # | `-- linkD -> ../dirB
1244 # |-- dirC
1245 # | |-- dirD
1246 # | | `-- fileD
1247 # | `-- fileC
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001248 # |-- dirE # No permissions
Antoine Pitrou31119e42013-11-22 17:38:12 +01001249 # |-- fileA
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001250 # |-- linkA -> fileA
1251 # `-- linkB -> dirB
Antoine Pitrou31119e42013-11-22 17:38:12 +01001252 #
1253
1254 def setUp(self):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001255 def cleanup():
1256 os.chmod(join('dirE'), 0o777)
1257 support.rmtree(BASE)
1258 self.addCleanup(cleanup)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001259 os.mkdir(BASE)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001260 os.mkdir(join('dirA'))
1261 os.mkdir(join('dirB'))
1262 os.mkdir(join('dirC'))
1263 os.mkdir(join('dirC', 'dirD'))
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001264 os.mkdir(join('dirE'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001265 with open(join('fileA'), 'wb') as f:
1266 f.write(b"this is file A\n")
1267 with open(join('dirB', 'fileB'), 'wb') as f:
1268 f.write(b"this is file B\n")
1269 with open(join('dirC', 'fileC'), 'wb') as f:
1270 f.write(b"this is file C\n")
1271 with open(join('dirC', 'dirD', 'fileD'), 'wb') as f:
1272 f.write(b"this is file D\n")
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001273 os.chmod(join('dirE'), 0)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001274 if not symlink_skip_reason:
Antoine Pitrou31119e42013-11-22 17:38:12 +01001275 # Relative symlinks
1276 os.symlink('fileA', join('linkA'))
1277 os.symlink('non-existing', join('brokenLink'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001278 self.dirlink('dirB', join('linkB'))
1279 self.dirlink(os.path.join('..', 'dirB'), join('dirA', 'linkC'))
Guido van Rossum69bfb152016-01-06 10:31:33 -08001280 # This one goes upwards, creating a loop
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001281 self.dirlink(os.path.join('..', 'dirB'), join('dirB', 'linkD'))
1282
1283 if os.name == 'nt':
1284 # Workaround for http://bugs.python.org/issue13772
1285 def dirlink(self, src, dest):
1286 os.symlink(src, dest, target_is_directory=True)
1287 else:
1288 def dirlink(self, src, dest):
1289 os.symlink(src, dest)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001290
1291 def assertSame(self, path_a, path_b):
1292 self.assertTrue(os.path.samefile(str(path_a), str(path_b)),
1293 "%r and %r don't point to the same file" %
1294 (path_a, path_b))
1295
1296 def assertFileNotFound(self, func, *args, **kwargs):
1297 with self.assertRaises(FileNotFoundError) as cm:
1298 func(*args, **kwargs)
1299 self.assertEqual(cm.exception.errno, errno.ENOENT)
1300
1301 def _test_cwd(self, p):
1302 q = self.cls(os.getcwd())
1303 self.assertEqual(p, q)
1304 self.assertEqual(str(p), str(q))
1305 self.assertIs(type(p), type(q))
1306 self.assertTrue(p.is_absolute())
1307
1308 def test_cwd(self):
1309 p = self.cls.cwd()
1310 self._test_cwd(p)
1311
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001312 def _test_home(self, p):
1313 q = self.cls(os.path.expanduser('~'))
1314 self.assertEqual(p, q)
1315 self.assertEqual(str(p), str(q))
1316 self.assertIs(type(p), type(q))
1317 self.assertTrue(p.is_absolute())
1318
1319 def test_home(self):
1320 p = self.cls.home()
1321 self._test_home(p)
1322
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001323 def test_samefile(self):
1324 fileA_path = os.path.join(BASE, 'fileA')
1325 fileB_path = os.path.join(BASE, 'dirB', 'fileB')
1326 p = self.cls(fileA_path)
1327 pp = self.cls(fileA_path)
1328 q = self.cls(fileB_path)
1329 self.assertTrue(p.samefile(fileA_path))
1330 self.assertTrue(p.samefile(pp))
1331 self.assertFalse(p.samefile(fileB_path))
1332 self.assertFalse(p.samefile(q))
1333 # Test the non-existent file case
1334 non_existent = os.path.join(BASE, 'foo')
1335 r = self.cls(non_existent)
1336 self.assertRaises(FileNotFoundError, p.samefile, r)
1337 self.assertRaises(FileNotFoundError, p.samefile, non_existent)
1338 self.assertRaises(FileNotFoundError, r.samefile, p)
1339 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1340 self.assertRaises(FileNotFoundError, r.samefile, r)
1341 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1342
Antoine Pitrou31119e42013-11-22 17:38:12 +01001343 def test_empty_path(self):
1344 # The empty path points to '.'
1345 p = self.cls('')
1346 self.assertEqual(p.stat(), os.stat('.'))
1347
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001348 def test_expanduser_common(self):
1349 P = self.cls
1350 p = P('~')
1351 self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))
1352 p = P('foo')
1353 self.assertEqual(p.expanduser(), p)
1354 p = P('/~')
1355 self.assertEqual(p.expanduser(), p)
1356 p = P('../~')
1357 self.assertEqual(p.expanduser(), p)
1358 p = P(P('').absolute().anchor) / '~'
1359 self.assertEqual(p.expanduser(), p)
1360
Antoine Pitrou31119e42013-11-22 17:38:12 +01001361 def test_exists(self):
1362 P = self.cls
1363 p = P(BASE)
1364 self.assertIs(True, p.exists())
1365 self.assertIs(True, (p / 'dirA').exists())
1366 self.assertIs(True, (p / 'fileA').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001367 self.assertIs(False, (p / 'fileA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001368 if not symlink_skip_reason:
1369 self.assertIs(True, (p / 'linkA').exists())
1370 self.assertIs(True, (p / 'linkB').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001371 self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1372 self.assertIs(False, (p / 'linkA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001373 self.assertIs(False, (p / 'foo').exists())
1374 self.assertIs(False, P('/xyzzy').exists())
1375
1376 def test_open_common(self):
1377 p = self.cls(BASE)
1378 with (p / 'fileA').open('r') as f:
1379 self.assertIsInstance(f, io.TextIOBase)
1380 self.assertEqual(f.read(), "this is file A\n")
1381 with (p / 'fileA').open('rb') as f:
1382 self.assertIsInstance(f, io.BufferedIOBase)
1383 self.assertEqual(f.read().strip(), b"this is file A")
1384 with (p / 'fileA').open('rb', buffering=0) as f:
1385 self.assertIsInstance(f, io.RawIOBase)
1386 self.assertEqual(f.read().strip(), b"this is file A")
1387
Georg Brandlea683982014-10-01 19:12:33 +02001388 def test_read_write_bytes(self):
1389 p = self.cls(BASE)
1390 (p / 'fileA').write_bytes(b'abcdefg')
1391 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1392 # check that trying to write str does not truncate the file
1393 self.assertRaises(TypeError, (p / 'fileA').write_bytes, 'somestr')
1394 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1395
1396 def test_read_write_text(self):
1397 p = self.cls(BASE)
1398 (p / 'fileA').write_text('äbcdefg', encoding='latin-1')
1399 self.assertEqual((p / 'fileA').read_text(
1400 encoding='utf-8', errors='ignore'), 'bcdefg')
1401 # check that trying to write bytes does not truncate the file
1402 self.assertRaises(TypeError, (p / 'fileA').write_text, b'somebytes')
1403 self.assertEqual((p / 'fileA').read_text(encoding='latin-1'), 'äbcdefg')
1404
Antoine Pitrou31119e42013-11-22 17:38:12 +01001405 def test_iterdir(self):
1406 P = self.cls
1407 p = P(BASE)
1408 it = p.iterdir()
1409 paths = set(it)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001410 expected = ['dirA', 'dirB', 'dirC', 'dirE', 'fileA']
Antoine Pitrou31119e42013-11-22 17:38:12 +01001411 if not symlink_skip_reason:
1412 expected += ['linkA', 'linkB', 'brokenLink']
1413 self.assertEqual(paths, { P(BASE, q) for q in expected })
1414
1415 @with_symlinks
1416 def test_iterdir_symlink(self):
1417 # __iter__ on a symlink to a directory
1418 P = self.cls
1419 p = P(BASE, 'linkB')
1420 paths = set(p.iterdir())
1421 expected = { P(BASE, 'linkB', q) for q in ['fileB', 'linkD'] }
1422 self.assertEqual(paths, expected)
1423
1424 def test_iterdir_nodir(self):
1425 # __iter__ on something that is not a directory
1426 p = self.cls(BASE, 'fileA')
1427 with self.assertRaises(OSError) as cm:
1428 next(p.iterdir())
1429 # ENOENT or EINVAL under Windows, ENOTDIR otherwise
1430 # (see issue #12802)
1431 self.assertIn(cm.exception.errno, (errno.ENOTDIR,
1432 errno.ENOENT, errno.EINVAL))
1433
1434 def test_glob_common(self):
1435 def _check(glob, expected):
1436 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1437 P = self.cls
1438 p = P(BASE)
1439 it = p.glob("fileA")
1440 self.assertIsInstance(it, collections.Iterator)
1441 _check(it, ["fileA"])
1442 _check(p.glob("fileB"), [])
1443 _check(p.glob("dir*/file*"), ["dirB/fileB", "dirC/fileC"])
1444 if symlink_skip_reason:
1445 _check(p.glob("*A"), ['dirA', 'fileA'])
1446 else:
1447 _check(p.glob("*A"), ['dirA', 'fileA', 'linkA'])
1448 if symlink_skip_reason:
1449 _check(p.glob("*B/*"), ['dirB/fileB'])
1450 else:
1451 _check(p.glob("*B/*"), ['dirB/fileB', 'dirB/linkD',
1452 'linkB/fileB', 'linkB/linkD'])
1453 if symlink_skip_reason:
1454 _check(p.glob("*/fileB"), ['dirB/fileB'])
1455 else:
1456 _check(p.glob("*/fileB"), ['dirB/fileB', 'linkB/fileB'])
1457
1458 def test_rglob_common(self):
1459 def _check(glob, expected):
1460 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1461 P = self.cls
1462 p = P(BASE)
1463 it = p.rglob("fileA")
1464 self.assertIsInstance(it, collections.Iterator)
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001465 _check(it, ["fileA"])
1466 _check(p.rglob("fileB"), ["dirB/fileB"])
1467 _check(p.rglob("*/fileA"), [])
Guido van Rossum9c39b672016-01-07 13:12:34 -08001468 if symlink_skip_reason:
1469 _check(p.rglob("*/fileB"), ["dirB/fileB"])
1470 else:
1471 _check(p.rglob("*/fileB"), ["dirB/fileB", "dirB/linkD/fileB",
1472 "linkB/fileB", "dirA/linkC/fileB"])
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001473 _check(p.rglob("file*"), ["fileA", "dirB/fileB",
1474 "dirC/fileC", "dirC/dirD/fileD"])
Antoine Pitrou31119e42013-11-22 17:38:12 +01001475 p = P(BASE, "dirC")
1476 _check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
1477 _check(p.rglob("*/*"), ["dirC/dirD/fileD"])
1478
Guido van Rossum69bfb152016-01-06 10:31:33 -08001479 @with_symlinks
1480 def test_rglob_symlink_loop(self):
1481 # Don't get fooled by symlink loops (Issue #26012)
1482 P = self.cls
1483 p = P(BASE)
1484 given = set(p.rglob('*'))
1485 expect = {'brokenLink',
1486 'dirA', 'dirA/linkC',
1487 'dirB', 'dirB/fileB', 'dirB/linkD',
1488 'dirC', 'dirC/dirD', 'dirC/dirD/fileD', 'dirC/fileC',
1489 'dirE',
1490 'fileA',
1491 'linkA',
1492 'linkB',
1493 }
1494 self.assertEqual(given, {p / x for x in expect})
1495
Antoine Pitrou31119e42013-11-22 17:38:12 +01001496 def test_glob_dotdot(self):
1497 # ".." is not special in globs
1498 P = self.cls
1499 p = P(BASE)
1500 self.assertEqual(set(p.glob("..")), { P(BASE, "..") })
1501 self.assertEqual(set(p.glob("dirA/../file*")), { P(BASE, "dirA/../fileA") })
1502 self.assertEqual(set(p.glob("../xyzzy")), set())
1503
1504 def _check_resolve_relative(self, p, expected):
1505 q = p.resolve()
1506 self.assertEqual(q, expected)
1507
1508 def _check_resolve_absolute(self, p, expected):
1509 q = p.resolve()
1510 self.assertEqual(q, expected)
1511
1512 @with_symlinks
1513 def test_resolve_common(self):
1514 P = self.cls
1515 p = P(BASE, 'foo')
1516 with self.assertRaises(OSError) as cm:
1517 p.resolve()
1518 self.assertEqual(cm.exception.errno, errno.ENOENT)
1519 # These are all relative symlinks
1520 p = P(BASE, 'dirB', 'fileB')
1521 self._check_resolve_relative(p, p)
1522 p = P(BASE, 'linkA')
1523 self._check_resolve_relative(p, P(BASE, 'fileA'))
1524 p = P(BASE, 'dirA', 'linkC', 'fileB')
1525 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1526 p = P(BASE, 'dirB', 'linkD', 'fileB')
1527 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1528 # Now create absolute symlinks
1529 d = tempfile.mkdtemp(suffix='-dirD')
Victor Stinnerec864692014-07-21 19:19:05 +02001530 self.addCleanup(support.rmtree, d)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001531 os.symlink(os.path.join(d), join('dirA', 'linkX'))
1532 os.symlink(join('dirB'), os.path.join(d, 'linkY'))
1533 p = P(BASE, 'dirA', 'linkX', 'linkY', 'fileB')
1534 self._check_resolve_absolute(p, P(BASE, 'dirB', 'fileB'))
1535
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001536 @with_symlinks
1537 def test_resolve_dot(self):
1538 # See https://bitbucket.org/pitrou/pathlib/issue/9/pathresolve-fails-on-complex-symlinks
1539 p = self.cls(BASE)
1540 self.dirlink('.', join('0'))
Antoine Pitroucc157512013-12-03 17:13:13 +01001541 self.dirlink(os.path.join('0', '0'), join('1'))
1542 self.dirlink(os.path.join('1', '1'), join('2'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001543 q = p / '2'
1544 self.assertEqual(q.resolve(), p)
1545
Antoine Pitrou31119e42013-11-22 17:38:12 +01001546 def test_with(self):
1547 p = self.cls(BASE)
1548 it = p.iterdir()
1549 it2 = p.iterdir()
1550 next(it2)
1551 with p:
1552 pass
1553 # I/O operation on closed path
1554 self.assertRaises(ValueError, next, it)
1555 self.assertRaises(ValueError, next, it2)
1556 self.assertRaises(ValueError, p.open)
1557 self.assertRaises(ValueError, p.resolve)
1558 self.assertRaises(ValueError, p.absolute)
1559 self.assertRaises(ValueError, p.__enter__)
1560
1561 def test_chmod(self):
1562 p = self.cls(BASE) / 'fileA'
1563 mode = p.stat().st_mode
1564 # Clear writable bit
1565 new_mode = mode & ~0o222
1566 p.chmod(new_mode)
1567 self.assertEqual(p.stat().st_mode, new_mode)
1568 # Set writable bit
1569 new_mode = mode | 0o222
1570 p.chmod(new_mode)
1571 self.assertEqual(p.stat().st_mode, new_mode)
1572
1573 # XXX also need a test for lchmod
1574
1575 def test_stat(self):
1576 p = self.cls(BASE) / 'fileA'
1577 st = p.stat()
1578 self.assertEqual(p.stat(), st)
1579 # Change file mode by flipping write bit
1580 p.chmod(st.st_mode ^ 0o222)
1581 self.addCleanup(p.chmod, st.st_mode)
1582 self.assertNotEqual(p.stat(), st)
1583
1584 @with_symlinks
1585 def test_lstat(self):
1586 p = self.cls(BASE)/ 'linkA'
1587 st = p.stat()
1588 self.assertNotEqual(st, p.lstat())
1589
1590 def test_lstat_nosymlink(self):
1591 p = self.cls(BASE) / 'fileA'
1592 st = p.stat()
1593 self.assertEqual(st, p.lstat())
1594
1595 @unittest.skipUnless(pwd, "the pwd module is needed for this test")
1596 def test_owner(self):
1597 p = self.cls(BASE) / 'fileA'
1598 uid = p.stat().st_uid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001599 try:
1600 name = pwd.getpwuid(uid).pw_name
1601 except KeyError:
1602 self.skipTest(
1603 "user %d doesn't have an entry in the system database" % uid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001604 self.assertEqual(name, p.owner())
1605
1606 @unittest.skipUnless(grp, "the grp module is needed for this test")
1607 def test_group(self):
1608 p = self.cls(BASE) / 'fileA'
1609 gid = p.stat().st_gid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001610 try:
1611 name = grp.getgrgid(gid).gr_name
1612 except KeyError:
1613 self.skipTest(
1614 "group %d doesn't have an entry in the system database" % gid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001615 self.assertEqual(name, p.group())
1616
1617 def test_unlink(self):
1618 p = self.cls(BASE) / 'fileA'
1619 p.unlink()
1620 self.assertFileNotFound(p.stat)
1621 self.assertFileNotFound(p.unlink)
1622
1623 def test_rmdir(self):
1624 p = self.cls(BASE) / 'dirA'
1625 for q in p.iterdir():
1626 q.unlink()
1627 p.rmdir()
1628 self.assertFileNotFound(p.stat)
1629 self.assertFileNotFound(p.unlink)
1630
1631 def test_rename(self):
1632 P = self.cls(BASE)
1633 p = P / 'fileA'
1634 size = p.stat().st_size
1635 # Renaming to another path
1636 q = P / 'dirA' / 'fileAA'
1637 p.rename(q)
1638 self.assertEqual(q.stat().st_size, size)
1639 self.assertFileNotFound(p.stat)
1640 # Renaming to a str of a relative path
1641 r = rel_join('fileAAA')
1642 q.rename(r)
1643 self.assertEqual(os.stat(r).st_size, size)
1644 self.assertFileNotFound(q.stat)
1645
1646 def test_replace(self):
1647 P = self.cls(BASE)
1648 p = P / 'fileA'
1649 size = p.stat().st_size
1650 # Replacing a non-existing path
1651 q = P / 'dirA' / 'fileAA'
1652 p.replace(q)
1653 self.assertEqual(q.stat().st_size, size)
1654 self.assertFileNotFound(p.stat)
1655 # Replacing another (existing) path
1656 r = rel_join('dirB', 'fileB')
1657 q.replace(r)
1658 self.assertEqual(os.stat(r).st_size, size)
1659 self.assertFileNotFound(q.stat)
1660
1661 def test_touch_common(self):
1662 P = self.cls(BASE)
1663 p = P / 'newfileA'
1664 self.assertFalse(p.exists())
1665 p.touch()
1666 self.assertTrue(p.exists())
Antoine Pitrou0f575642013-11-22 23:20:08 +01001667 st = p.stat()
1668 old_mtime = st.st_mtime
1669 old_mtime_ns = st.st_mtime_ns
Antoine Pitrou31119e42013-11-22 17:38:12 +01001670 # Rewind the mtime sufficiently far in the past to work around
1671 # filesystem-specific timestamp granularity.
1672 os.utime(str(p), (old_mtime - 10, old_mtime - 10))
Antoine Pitroubb6694d2013-11-23 01:32:53 +01001673 # The file mtime should be refreshed by calling touch() again
Antoine Pitrou31119e42013-11-22 17:38:12 +01001674 p.touch()
Antoine Pitrou0f575642013-11-22 23:20:08 +01001675 st = p.stat()
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001676 self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)
1677 self.assertGreaterEqual(st.st_mtime, old_mtime)
Antoine Pitroubb6694d2013-11-23 01:32:53 +01001678 # Now with exist_ok=False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001679 p = P / 'newfileB'
1680 self.assertFalse(p.exists())
1681 p.touch(mode=0o700, exist_ok=False)
1682 self.assertTrue(p.exists())
1683 self.assertRaises(OSError, p.touch, exist_ok=False)
1684
Antoine Pitrou8b784932013-11-23 14:52:39 +01001685 def test_touch_nochange(self):
1686 P = self.cls(BASE)
1687 p = P / 'fileA'
1688 p.touch()
1689 with p.open('rb') as f:
1690 self.assertEqual(f.read().strip(), b"this is file A")
1691
Antoine Pitrou31119e42013-11-22 17:38:12 +01001692 def test_mkdir(self):
1693 P = self.cls(BASE)
1694 p = P / 'newdirA'
1695 self.assertFalse(p.exists())
1696 p.mkdir()
1697 self.assertTrue(p.exists())
1698 self.assertTrue(p.is_dir())
1699 with self.assertRaises(OSError) as cm:
1700 p.mkdir()
1701 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001702
1703 def test_mkdir_parents(self):
1704 # Creating a chain of directories
1705 p = self.cls(BASE, 'newdirB', 'newdirC')
1706 self.assertFalse(p.exists())
1707 with self.assertRaises(OSError) as cm:
1708 p.mkdir()
1709 self.assertEqual(cm.exception.errno, errno.ENOENT)
1710 p.mkdir(parents=True)
1711 self.assertTrue(p.exists())
1712 self.assertTrue(p.is_dir())
1713 with self.assertRaises(OSError) as cm:
1714 p.mkdir(parents=True)
1715 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou0048c982013-12-16 20:22:37 +01001716 # test `mode` arg
1717 mode = stat.S_IMODE(p.stat().st_mode) # default mode
1718 p = self.cls(BASE, 'newdirD', 'newdirE')
1719 p.mkdir(0o555, parents=True)
1720 self.assertTrue(p.exists())
1721 self.assertTrue(p.is_dir())
1722 if os.name != 'nt':
1723 # the directory's permissions follow the mode argument
Gregory P. Smithb599c612014-01-20 01:10:33 -08001724 self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)
Antoine Pitrou0048c982013-12-16 20:22:37 +01001725 # the parent's permissions follow the default process settings
1726 self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001727
Barry Warsaw7c549c42014-08-05 11:28:12 -04001728 def test_mkdir_exist_ok(self):
1729 p = self.cls(BASE, 'dirB')
1730 st_ctime_first = p.stat().st_ctime
1731 self.assertTrue(p.exists())
1732 self.assertTrue(p.is_dir())
1733 with self.assertRaises(FileExistsError) as cm:
1734 p.mkdir()
1735 self.assertEqual(cm.exception.errno, errno.EEXIST)
1736 p.mkdir(exist_ok=True)
1737 self.assertTrue(p.exists())
1738 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1739
1740 def test_mkdir_exist_ok_with_parent(self):
1741 p = self.cls(BASE, 'dirC')
1742 self.assertTrue(p.exists())
1743 with self.assertRaises(FileExistsError) as cm:
1744 p.mkdir()
1745 self.assertEqual(cm.exception.errno, errno.EEXIST)
1746 p = p / 'newdirC'
1747 p.mkdir(parents=True)
1748 st_ctime_first = p.stat().st_ctime
1749 self.assertTrue(p.exists())
1750 with self.assertRaises(FileExistsError) as cm:
1751 p.mkdir(parents=True)
1752 self.assertEqual(cm.exception.errno, errno.EEXIST)
1753 p.mkdir(parents=True, exist_ok=True)
1754 self.assertTrue(p.exists())
1755 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1756
1757 def test_mkdir_with_child_file(self):
1758 p = self.cls(BASE, 'dirB', 'fileB')
1759 self.assertTrue(p.exists())
1760 # An exception is raised when the last path component is an existing
1761 # regular file, regardless of whether exist_ok is true or not.
1762 with self.assertRaises(FileExistsError) as cm:
1763 p.mkdir(parents=True)
1764 self.assertEqual(cm.exception.errno, errno.EEXIST)
1765 with self.assertRaises(FileExistsError) as cm:
1766 p.mkdir(parents=True, exist_ok=True)
1767 self.assertEqual(cm.exception.errno, errno.EEXIST)
1768
1769 def test_mkdir_no_parents_file(self):
1770 p = self.cls(BASE, 'fileA')
1771 self.assertTrue(p.exists())
1772 # An exception is raised when the last path component is an existing
1773 # regular file, regardless of whether exist_ok is true or not.
1774 with self.assertRaises(FileExistsError) as cm:
1775 p.mkdir()
1776 self.assertEqual(cm.exception.errno, errno.EEXIST)
1777 with self.assertRaises(FileExistsError) as cm:
1778 p.mkdir(exist_ok=True)
1779 self.assertEqual(cm.exception.errno, errno.EEXIST)
1780
Antoine Pitrou31119e42013-11-22 17:38:12 +01001781 @with_symlinks
1782 def test_symlink_to(self):
1783 P = self.cls(BASE)
1784 target = P / 'fileA'
1785 # Symlinking a path target
1786 link = P / 'dirA' / 'linkAA'
1787 link.symlink_to(target)
1788 self.assertEqual(link.stat(), target.stat())
1789 self.assertNotEqual(link.lstat(), target.stat())
1790 # Symlinking a str target
1791 link = P / 'dirA' / 'linkAAA'
1792 link.symlink_to(str(target))
1793 self.assertEqual(link.stat(), target.stat())
1794 self.assertNotEqual(link.lstat(), target.stat())
1795 self.assertFalse(link.is_dir())
1796 # Symlinking to a directory
1797 target = P / 'dirB'
1798 link = P / 'dirA' / 'linkAAAA'
1799 link.symlink_to(target, target_is_directory=True)
1800 self.assertEqual(link.stat(), target.stat())
1801 self.assertNotEqual(link.lstat(), target.stat())
1802 self.assertTrue(link.is_dir())
1803 self.assertTrue(list(link.iterdir()))
1804
1805 def test_is_dir(self):
1806 P = self.cls(BASE)
1807 self.assertTrue((P / 'dirA').is_dir())
1808 self.assertFalse((P / 'fileA').is_dir())
1809 self.assertFalse((P / 'non-existing').is_dir())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001810 self.assertFalse((P / 'fileA' / 'bah').is_dir())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001811 if not symlink_skip_reason:
1812 self.assertFalse((P / 'linkA').is_dir())
1813 self.assertTrue((P / 'linkB').is_dir())
1814 self.assertFalse((P/ 'brokenLink').is_dir())
1815
1816 def test_is_file(self):
1817 P = self.cls(BASE)
1818 self.assertTrue((P / 'fileA').is_file())
1819 self.assertFalse((P / 'dirA').is_file())
1820 self.assertFalse((P / 'non-existing').is_file())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001821 self.assertFalse((P / 'fileA' / 'bah').is_file())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001822 if not symlink_skip_reason:
1823 self.assertTrue((P / 'linkA').is_file())
1824 self.assertFalse((P / 'linkB').is_file())
1825 self.assertFalse((P/ 'brokenLink').is_file())
1826
1827 def test_is_symlink(self):
1828 P = self.cls(BASE)
1829 self.assertFalse((P / 'fileA').is_symlink())
1830 self.assertFalse((P / 'dirA').is_symlink())
1831 self.assertFalse((P / 'non-existing').is_symlink())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001832 self.assertFalse((P / 'fileA' / 'bah').is_symlink())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001833 if not symlink_skip_reason:
1834 self.assertTrue((P / 'linkA').is_symlink())
1835 self.assertTrue((P / 'linkB').is_symlink())
1836 self.assertTrue((P/ 'brokenLink').is_symlink())
1837
1838 def test_is_fifo_false(self):
1839 P = self.cls(BASE)
1840 self.assertFalse((P / 'fileA').is_fifo())
1841 self.assertFalse((P / 'dirA').is_fifo())
1842 self.assertFalse((P / 'non-existing').is_fifo())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001843 self.assertFalse((P / 'fileA' / 'bah').is_fifo())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001844
1845 @unittest.skipUnless(hasattr(os, "mkfifo"), "os.mkfifo() required")
1846 def test_is_fifo_true(self):
1847 P = self.cls(BASE, 'myfifo')
1848 os.mkfifo(str(P))
1849 self.assertTrue(P.is_fifo())
1850 self.assertFalse(P.is_socket())
1851 self.assertFalse(P.is_file())
1852
1853 def test_is_socket_false(self):
1854 P = self.cls(BASE)
1855 self.assertFalse((P / 'fileA').is_socket())
1856 self.assertFalse((P / 'dirA').is_socket())
1857 self.assertFalse((P / 'non-existing').is_socket())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001858 self.assertFalse((P / 'fileA' / 'bah').is_socket())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001859
1860 @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required")
1861 def test_is_socket_true(self):
1862 P = self.cls(BASE, 'mysock')
Antoine Pitrou330ce592013-11-22 18:05:06 +01001863 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001864 self.addCleanup(sock.close)
Antoine Pitrou330ce592013-11-22 18:05:06 +01001865 try:
1866 sock.bind(str(P))
1867 except OSError as e:
1868 if "AF_UNIX path too long" in str(e):
1869 self.skipTest("cannot bind Unix socket: " + str(e))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001870 self.assertTrue(P.is_socket())
1871 self.assertFalse(P.is_fifo())
1872 self.assertFalse(P.is_file())
1873
1874 def test_is_block_device_false(self):
1875 P = self.cls(BASE)
1876 self.assertFalse((P / 'fileA').is_block_device())
1877 self.assertFalse((P / 'dirA').is_block_device())
1878 self.assertFalse((P / 'non-existing').is_block_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001879 self.assertFalse((P / 'fileA' / 'bah').is_block_device())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001880
1881 def test_is_char_device_false(self):
1882 P = self.cls(BASE)
1883 self.assertFalse((P / 'fileA').is_char_device())
1884 self.assertFalse((P / 'dirA').is_char_device())
1885 self.assertFalse((P / 'non-existing').is_char_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001886 self.assertFalse((P / 'fileA' / 'bah').is_char_device())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001887
1888 def test_is_char_device_true(self):
1889 # Under Unix, /dev/null should generally be a char device
1890 P = self.cls('/dev/null')
1891 if not P.exists():
1892 self.skipTest("/dev/null required")
1893 self.assertTrue(P.is_char_device())
1894 self.assertFalse(P.is_block_device())
1895 self.assertFalse(P.is_file())
1896
1897 def test_pickling_common(self):
1898 p = self.cls(BASE, 'fileA')
1899 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
1900 dumped = pickle.dumps(p, proto)
1901 pp = pickle.loads(dumped)
1902 self.assertEqual(pp.stat(), p.stat())
1903
1904 def test_parts_interning(self):
1905 P = self.cls
1906 p = P('/usr/bin/foo')
1907 q = P('/usr/local/bin')
1908 # 'usr'
1909 self.assertIs(p.parts[1], q.parts[1])
1910 # 'bin'
1911 self.assertIs(p.parts[2], q.parts[3])
1912
Antoine Pitrouc274fd22013-12-16 19:57:41 +01001913 def _check_complex_symlinks(self, link0_target):
1914 # Test solving a non-looping chain of symlinks (issue #19887)
1915 P = self.cls(BASE)
1916 self.dirlink(os.path.join('link0', 'link0'), join('link1'))
1917 self.dirlink(os.path.join('link1', 'link1'), join('link2'))
1918 self.dirlink(os.path.join('link2', 'link2'), join('link3'))
1919 self.dirlink(link0_target, join('link0'))
1920
1921 # Resolve absolute paths
1922 p = (P / 'link0').resolve()
1923 self.assertEqual(p, P)
1924 self.assertEqual(str(p), BASE)
1925 p = (P / 'link1').resolve()
1926 self.assertEqual(p, P)
1927 self.assertEqual(str(p), BASE)
1928 p = (P / 'link2').resolve()
1929 self.assertEqual(p, P)
1930 self.assertEqual(str(p), BASE)
1931 p = (P / 'link3').resolve()
1932 self.assertEqual(p, P)
1933 self.assertEqual(str(p), BASE)
1934
1935 # Resolve relative paths
1936 old_path = os.getcwd()
1937 os.chdir(BASE)
1938 try:
1939 p = self.cls('link0').resolve()
1940 self.assertEqual(p, P)
1941 self.assertEqual(str(p), BASE)
1942 p = self.cls('link1').resolve()
1943 self.assertEqual(p, P)
1944 self.assertEqual(str(p), BASE)
1945 p = self.cls('link2').resolve()
1946 self.assertEqual(p, P)
1947 self.assertEqual(str(p), BASE)
1948 p = self.cls('link3').resolve()
1949 self.assertEqual(p, P)
1950 self.assertEqual(str(p), BASE)
1951 finally:
1952 os.chdir(old_path)
1953
1954 @with_symlinks
1955 def test_complex_symlinks_absolute(self):
1956 self._check_complex_symlinks(BASE)
1957
1958 @with_symlinks
1959 def test_complex_symlinks_relative(self):
1960 self._check_complex_symlinks('.')
1961
1962 @with_symlinks
1963 def test_complex_symlinks_relative_dot_dot(self):
1964 self._check_complex_symlinks(os.path.join('dirA', '..'))
1965
Antoine Pitrou31119e42013-11-22 17:38:12 +01001966
1967class PathTest(_BasePathTest, unittest.TestCase):
1968 cls = pathlib.Path
1969
1970 def test_concrete_class(self):
1971 p = self.cls('a')
1972 self.assertIs(type(p),
1973 pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath)
1974
1975 def test_unsupported_flavour(self):
1976 if os.name == 'nt':
1977 self.assertRaises(NotImplementedError, pathlib.PosixPath)
1978 else:
1979 self.assertRaises(NotImplementedError, pathlib.WindowsPath)
1980
Berker Peksag4a208e42016-01-30 17:50:48 +02001981 def test_glob_empty_pattern(self):
1982 p = self.cls()
1983 with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
1984 list(p.glob(''))
1985
Antoine Pitrou31119e42013-11-22 17:38:12 +01001986
1987@only_posix
1988class PosixPathTest(_BasePathTest, unittest.TestCase):
1989 cls = pathlib.PosixPath
1990
1991 def _check_symlink_loop(self, *args):
1992 path = self.cls(*args)
1993 with self.assertRaises(RuntimeError):
1994 print(path.resolve())
1995
1996 def test_open_mode(self):
1997 old_mask = os.umask(0)
1998 self.addCleanup(os.umask, old_mask)
1999 p = self.cls(BASE)
2000 with (p / 'new_file').open('wb'):
2001 pass
2002 st = os.stat(join('new_file'))
2003 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2004 os.umask(0o022)
2005 with (p / 'other_new_file').open('wb'):
2006 pass
2007 st = os.stat(join('other_new_file'))
2008 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2009
2010 def test_touch_mode(self):
2011 old_mask = os.umask(0)
2012 self.addCleanup(os.umask, old_mask)
2013 p = self.cls(BASE)
2014 (p / 'new_file').touch()
2015 st = os.stat(join('new_file'))
2016 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2017 os.umask(0o022)
2018 (p / 'other_new_file').touch()
2019 st = os.stat(join('other_new_file'))
2020 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2021 (p / 'masked_new_file').touch(mode=0o750)
2022 st = os.stat(join('masked_new_file'))
2023 self.assertEqual(stat.S_IMODE(st.st_mode), 0o750)
2024
2025 @with_symlinks
2026 def test_resolve_loop(self):
2027 # Loop detection for broken symlinks under POSIX
Antoine Pitrou31119e42013-11-22 17:38:12 +01002028 # Loops with relative symlinks
2029 os.symlink('linkX/inside', join('linkX'))
2030 self._check_symlink_loop(BASE, 'linkX')
2031 os.symlink('linkY', join('linkY'))
2032 self._check_symlink_loop(BASE, 'linkY')
2033 os.symlink('linkZ/../linkZ', join('linkZ'))
2034 self._check_symlink_loop(BASE, 'linkZ')
2035 # Loops with absolute symlinks
2036 os.symlink(join('linkU/inside'), join('linkU'))
2037 self._check_symlink_loop(BASE, 'linkU')
2038 os.symlink(join('linkV'), join('linkV'))
2039 self._check_symlink_loop(BASE, 'linkV')
2040 os.symlink(join('linkW/../linkW'), join('linkW'))
2041 self._check_symlink_loop(BASE, 'linkW')
2042
2043 def test_glob(self):
2044 P = self.cls
2045 p = P(BASE)
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002046 given = set(p.glob("FILEa"))
2047 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2048 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002049 self.assertEqual(set(p.glob("FILEa*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002050
2051 def test_rglob(self):
2052 P = self.cls
2053 p = P(BASE, "dirC")
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002054 given = set(p.rglob("FILEd"))
2055 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2056 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002057 self.assertEqual(set(p.rglob("FILEd*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002058
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002059 def test_expanduser(self):
2060 P = self.cls
2061 support.import_module('pwd')
2062 import pwd
2063 pwdent = pwd.getpwuid(os.getuid())
2064 username = pwdent.pw_name
Serhiy Storchakaa3fd0b22016-05-03 21:17:03 +03002065 userhome = pwdent.pw_dir.rstrip('/') or '/'
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002066 # find arbitrary different user (if exists)
2067 for pwdent in pwd.getpwall():
2068 othername = pwdent.pw_name
2069 otherhome = pwdent.pw_dir.rstrip('/')
Victor Stinnere9694392015-01-10 09:00:20 +01002070 if othername != username and otherhome:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002071 break
2072
2073 p1 = P('~/Documents')
2074 p2 = P('~' + username + '/Documents')
2075 p3 = P('~' + othername + '/Documents')
2076 p4 = P('../~' + username + '/Documents')
2077 p5 = P('/~' + username + '/Documents')
2078 p6 = P('')
2079 p7 = P('~fakeuser/Documents')
2080
2081 with support.EnvironmentVarGuard() as env:
2082 env.pop('HOME', None)
2083
2084 self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
2085 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2086 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2087 self.assertEqual(p4.expanduser(), p4)
2088 self.assertEqual(p5.expanduser(), p5)
2089 self.assertEqual(p6.expanduser(), p6)
2090 self.assertRaises(RuntimeError, p7.expanduser)
2091
2092 env['HOME'] = '/tmp'
2093 self.assertEqual(p1.expanduser(), P('/tmp/Documents'))
2094 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2095 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2096 self.assertEqual(p4.expanduser(), p4)
2097 self.assertEqual(p5.expanduser(), p5)
2098 self.assertEqual(p6.expanduser(), p6)
2099 self.assertRaises(RuntimeError, p7.expanduser)
2100
Antoine Pitrou31119e42013-11-22 17:38:12 +01002101
2102@only_nt
2103class WindowsPathTest(_BasePathTest, unittest.TestCase):
2104 cls = pathlib.WindowsPath
2105
2106 def test_glob(self):
2107 P = self.cls
2108 p = P(BASE)
2109 self.assertEqual(set(p.glob("FILEa")), { P(BASE, "fileA") })
2110
2111 def test_rglob(self):
2112 P = self.cls
2113 p = P(BASE, "dirC")
2114 self.assertEqual(set(p.rglob("FILEd")), { P(BASE, "dirC/dirD/fileD") })
2115
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002116 def test_expanduser(self):
2117 P = self.cls
2118 with support.EnvironmentVarGuard() as env:
2119 env.pop('HOME', None)
2120 env.pop('USERPROFILE', None)
2121 env.pop('HOMEPATH', None)
2122 env.pop('HOMEDRIVE', None)
2123 env['USERNAME'] = 'alice'
2124
2125 # test that the path returns unchanged
2126 p1 = P('~/My Documents')
2127 p2 = P('~alice/My Documents')
2128 p3 = P('~bob/My Documents')
2129 p4 = P('/~/My Documents')
2130 p5 = P('d:~/My Documents')
2131 p6 = P('')
2132 self.assertRaises(RuntimeError, p1.expanduser)
2133 self.assertRaises(RuntimeError, p2.expanduser)
2134 self.assertRaises(RuntimeError, p3.expanduser)
2135 self.assertEqual(p4.expanduser(), p4)
2136 self.assertEqual(p5.expanduser(), p5)
2137 self.assertEqual(p6.expanduser(), p6)
2138
2139 def check():
2140 env.pop('USERNAME', None)
2141 self.assertEqual(p1.expanduser(),
2142 P('C:/Users/alice/My Documents'))
2143 self.assertRaises(KeyError, p2.expanduser)
2144 env['USERNAME'] = 'alice'
2145 self.assertEqual(p2.expanduser(),
2146 P('C:/Users/alice/My Documents'))
2147 self.assertEqual(p3.expanduser(),
2148 P('C:/Users/bob/My Documents'))
2149 self.assertEqual(p4.expanduser(), p4)
2150 self.assertEqual(p5.expanduser(), p5)
2151 self.assertEqual(p6.expanduser(), p6)
2152
2153 # test the first lookup key in the env vars
2154 env['HOME'] = 'C:\\Users\\alice'
2155 check()
2156
2157 # test that HOMEPATH is available instead
2158 env.pop('HOME', None)
2159 env['HOMEPATH'] = 'C:\\Users\\alice'
2160 check()
2161
2162 env['HOMEDRIVE'] = 'C:\\'
2163 env['HOMEPATH'] = 'Users\\alice'
2164 check()
2165
2166 env.pop('HOMEDRIVE', None)
2167 env.pop('HOMEPATH', None)
2168 env['USERPROFILE'] = 'C:\\Users\\alice'
2169 check()
2170
Antoine Pitrou31119e42013-11-22 17:38:12 +01002171
2172if __name__ == "__main__":
2173 unittest.main()