blob: fa96d9f882c9e2baa61fb73dbc34acb584ad3ac7 [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
480 def test_suffix_common(self):
481 P = self.cls
482 self.assertEqual(P('').suffix, '')
483 self.assertEqual(P('.').suffix, '')
484 self.assertEqual(P('..').suffix, '')
485 self.assertEqual(P('/').suffix, '')
486 self.assertEqual(P('a/b').suffix, '')
487 self.assertEqual(P('/a/b').suffix, '')
488 self.assertEqual(P('/a/b/.').suffix, '')
489 self.assertEqual(P('a/b.py').suffix, '.py')
490 self.assertEqual(P('/a/b.py').suffix, '.py')
491 self.assertEqual(P('a/.hgrc').suffix, '')
492 self.assertEqual(P('/a/.hgrc').suffix, '')
493 self.assertEqual(P('a/.hg.rc').suffix, '.rc')
494 self.assertEqual(P('/a/.hg.rc').suffix, '.rc')
495 self.assertEqual(P('a/b.tar.gz').suffix, '.gz')
496 self.assertEqual(P('/a/b.tar.gz').suffix, '.gz')
497 self.assertEqual(P('a/Some name. Ending with a dot.').suffix, '')
498 self.assertEqual(P('/a/Some name. Ending with a dot.').suffix, '')
499
500 def test_suffixes_common(self):
501 P = self.cls
502 self.assertEqual(P('').suffixes, [])
503 self.assertEqual(P('.').suffixes, [])
504 self.assertEqual(P('/').suffixes, [])
505 self.assertEqual(P('a/b').suffixes, [])
506 self.assertEqual(P('/a/b').suffixes, [])
507 self.assertEqual(P('/a/b/.').suffixes, [])
508 self.assertEqual(P('a/b.py').suffixes, ['.py'])
509 self.assertEqual(P('/a/b.py').suffixes, ['.py'])
510 self.assertEqual(P('a/.hgrc').suffixes, [])
511 self.assertEqual(P('/a/.hgrc').suffixes, [])
512 self.assertEqual(P('a/.hg.rc').suffixes, ['.rc'])
513 self.assertEqual(P('/a/.hg.rc').suffixes, ['.rc'])
514 self.assertEqual(P('a/b.tar.gz').suffixes, ['.tar', '.gz'])
515 self.assertEqual(P('/a/b.tar.gz').suffixes, ['.tar', '.gz'])
516 self.assertEqual(P('a/Some name. Ending with a dot.').suffixes, [])
517 self.assertEqual(P('/a/Some name. Ending with a dot.').suffixes, [])
518
519 def test_stem_common(self):
520 P = self.cls
521 self.assertEqual(P('').stem, '')
522 self.assertEqual(P('.').stem, '')
523 self.assertEqual(P('..').stem, '..')
524 self.assertEqual(P('/').stem, '')
525 self.assertEqual(P('a/b').stem, 'b')
526 self.assertEqual(P('a/b.py').stem, 'b')
527 self.assertEqual(P('a/.hgrc').stem, '.hgrc')
528 self.assertEqual(P('a/.hg.rc').stem, '.hg')
529 self.assertEqual(P('a/b.tar.gz').stem, 'b.tar')
530 self.assertEqual(P('a/Some name. Ending with a dot.').stem,
531 'Some name. Ending with a dot.')
532
533 def test_with_name_common(self):
534 P = self.cls
535 self.assertEqual(P('a/b').with_name('d.xml'), P('a/d.xml'))
536 self.assertEqual(P('/a/b').with_name('d.xml'), P('/a/d.xml'))
537 self.assertEqual(P('a/b.py').with_name('d.xml'), P('a/d.xml'))
538 self.assertEqual(P('/a/b.py').with_name('d.xml'), P('/a/d.xml'))
539 self.assertEqual(P('a/Dot ending.').with_name('d.xml'), P('a/d.xml'))
540 self.assertEqual(P('/a/Dot ending.').with_name('d.xml'), P('/a/d.xml'))
541 self.assertRaises(ValueError, P('').with_name, 'd.xml')
542 self.assertRaises(ValueError, P('.').with_name, 'd.xml')
543 self.assertRaises(ValueError, P('/').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400544 self.assertRaises(ValueError, P('a/b').with_name, '')
545 self.assertRaises(ValueError, P('a/b').with_name, '/c')
546 self.assertRaises(ValueError, P('a/b').with_name, 'c/')
547 self.assertRaises(ValueError, P('a/b').with_name, 'c/d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100548
549 def test_with_suffix_common(self):
550 P = self.cls
551 self.assertEqual(P('a/b').with_suffix('.gz'), P('a/b.gz'))
552 self.assertEqual(P('/a/b').with_suffix('.gz'), P('/a/b.gz'))
553 self.assertEqual(P('a/b.py').with_suffix('.gz'), P('a/b.gz'))
554 self.assertEqual(P('/a/b.py').with_suffix('.gz'), P('/a/b.gz'))
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400555 # Stripping suffix
556 self.assertEqual(P('a/b.py').with_suffix(''), P('a/b'))
557 self.assertEqual(P('/a/b').with_suffix(''), P('/a/b'))
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100558 # Path doesn't have a "filename" component
Antoine Pitrou31119e42013-11-22 17:38:12 +0100559 self.assertRaises(ValueError, P('').with_suffix, '.gz')
560 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
561 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100562 # Invalid suffix
563 self.assertRaises(ValueError, P('a/b').with_suffix, 'gz')
564 self.assertRaises(ValueError, P('a/b').with_suffix, '/')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400565 self.assertRaises(ValueError, P('a/b').with_suffix, '.')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100566 self.assertRaises(ValueError, P('a/b').with_suffix, '/.gz')
567 self.assertRaises(ValueError, P('a/b').with_suffix, 'c/d')
568 self.assertRaises(ValueError, P('a/b').with_suffix, '.c/.d')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400569 self.assertRaises(ValueError, P('a/b').with_suffix, './.d')
570 self.assertRaises(ValueError, P('a/b').with_suffix, '.d/.')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100571
572 def test_relative_to_common(self):
573 P = self.cls
574 p = P('a/b')
575 self.assertRaises(TypeError, p.relative_to)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100576 self.assertRaises(TypeError, p.relative_to, b'a')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100577 self.assertEqual(p.relative_to(P()), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100578 self.assertEqual(p.relative_to(''), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100579 self.assertEqual(p.relative_to(P('a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100580 self.assertEqual(p.relative_to('a'), P('b'))
581 self.assertEqual(p.relative_to('a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100582 self.assertEqual(p.relative_to(P('a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100583 self.assertEqual(p.relative_to('a/b'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +0100584 # With several args
585 self.assertEqual(p.relative_to('a', 'b'), P())
586 # Unrelated paths
587 self.assertRaises(ValueError, p.relative_to, P('c'))
588 self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
589 self.assertRaises(ValueError, p.relative_to, P('a/c'))
590 self.assertRaises(ValueError, p.relative_to, P('/a'))
591 p = P('/a/b')
592 self.assertEqual(p.relative_to(P('/')), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100593 self.assertEqual(p.relative_to('/'), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100594 self.assertEqual(p.relative_to(P('/a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100595 self.assertEqual(p.relative_to('/a'), P('b'))
596 self.assertEqual(p.relative_to('/a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100597 self.assertEqual(p.relative_to(P('/a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100598 self.assertEqual(p.relative_to('/a/b'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +0100599 # Unrelated paths
600 self.assertRaises(ValueError, p.relative_to, P('/c'))
601 self.assertRaises(ValueError, p.relative_to, P('/a/b/c'))
602 self.assertRaises(ValueError, p.relative_to, P('/a/c'))
603 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100604 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100605 self.assertRaises(ValueError, p.relative_to, P('a'))
606
607 def test_pickling_common(self):
608 P = self.cls
609 p = P('/a/b')
610 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
611 dumped = pickle.dumps(p, proto)
612 pp = pickle.loads(dumped)
613 self.assertIs(pp.__class__, p.__class__)
614 self.assertEqual(pp, p)
615 self.assertEqual(hash(pp), hash(p))
616 self.assertEqual(str(pp), str(p))
617
618
619class PurePosixPathTest(_BasePurePathTest, unittest.TestCase):
620 cls = pathlib.PurePosixPath
621
622 def test_root(self):
623 P = self.cls
624 self.assertEqual(P('/a/b').root, '/')
625 self.assertEqual(P('///a/b').root, '/')
626 # POSIX special case for two leading slashes
627 self.assertEqual(P('//a/b').root, '//')
628
629 def test_eq(self):
630 P = self.cls
631 self.assertNotEqual(P('a/b'), P('A/b'))
632 self.assertEqual(P('/a'), P('///a'))
633 self.assertNotEqual(P('/a'), P('//a'))
634
635 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100636 P = self.cls
637 self.assertEqual(P('/').as_uri(), 'file:///')
638 self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')
639 self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')
Antoine Pitrou29eac422013-11-22 17:57:03 +0100640
641 def test_as_uri_non_ascii(self):
642 from urllib.parse import quote_from_bytes
643 P = self.cls
644 try:
645 os.fsencode('\xe9')
646 except UnicodeEncodeError:
647 self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")
Antoine Pitrou31119e42013-11-22 17:38:12 +0100648 self.assertEqual(P('/a/b\xe9').as_uri(),
649 'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))
650
651 def test_match(self):
652 P = self.cls
653 self.assertFalse(P('A.py').match('a.PY'))
654
655 def test_is_absolute(self):
656 P = self.cls
657 self.assertFalse(P().is_absolute())
658 self.assertFalse(P('a').is_absolute())
659 self.assertFalse(P('a/b/').is_absolute())
660 self.assertTrue(P('/').is_absolute())
661 self.assertTrue(P('/a').is_absolute())
662 self.assertTrue(P('/a/b/').is_absolute())
663 self.assertTrue(P('//a').is_absolute())
664 self.assertTrue(P('//a/b').is_absolute())
665
666 def test_is_reserved(self):
667 P = self.cls
668 self.assertIs(False, P('').is_reserved())
669 self.assertIs(False, P('/').is_reserved())
670 self.assertIs(False, P('/foo/bar').is_reserved())
671 self.assertIs(False, P('/dev/con/PRN/NUL').is_reserved())
672
673 def test_join(self):
674 P = self.cls
675 p = P('//a')
676 pp = p.joinpath('b')
677 self.assertEqual(pp, P('//a/b'))
678 pp = P('/a').joinpath('//c')
679 self.assertEqual(pp, P('//c'))
680 pp = P('//a').joinpath('/c')
681 self.assertEqual(pp, P('/c'))
682
683 def test_div(self):
684 # Basically the same as joinpath()
685 P = self.cls
686 p = P('//a')
687 pp = p / 'b'
688 self.assertEqual(pp, P('//a/b'))
689 pp = P('/a') / '//c'
690 self.assertEqual(pp, P('//c'))
691 pp = P('//a') / '/c'
692 self.assertEqual(pp, P('/c'))
693
694
695class PureWindowsPathTest(_BasePurePathTest, unittest.TestCase):
696 cls = pathlib.PureWindowsPath
697
698 equivalences = _BasePurePathTest.equivalences.copy()
699 equivalences.update({
700 'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('/', 'c:', 'a') ],
701 'c:/a': [
702 ('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),
703 ('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),
704 ],
705 '//a/b/': [ ('//a/b',) ],
706 '//a/b/c': [
707 ('//a/b', 'c'), ('//a/b/', 'c'),
708 ],
709 })
710
711 def test_str(self):
712 p = self.cls('a/b/c')
713 self.assertEqual(str(p), 'a\\b\\c')
714 p = self.cls('c:/a/b/c')
715 self.assertEqual(str(p), 'c:\\a\\b\\c')
716 p = self.cls('//a/b')
717 self.assertEqual(str(p), '\\\\a\\b\\')
718 p = self.cls('//a/b/c')
719 self.assertEqual(str(p), '\\\\a\\b\\c')
720 p = self.cls('//a/b/c/d')
721 self.assertEqual(str(p), '\\\\a\\b\\c\\d')
722
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200723 def test_str_subclass(self):
724 self._check_str_subclass('c:')
725 self._check_str_subclass('c:a')
726 self._check_str_subclass('c:a\\b.txt')
727 self._check_str_subclass('c:\\')
728 self._check_str_subclass('c:\\a')
729 self._check_str_subclass('c:\\a\\b.txt')
730 self._check_str_subclass('\\\\some\\share')
731 self._check_str_subclass('\\\\some\\share\\a')
732 self._check_str_subclass('\\\\some\\share\\a\\b.txt')
733
Antoine Pitrou31119e42013-11-22 17:38:12 +0100734 def test_eq(self):
735 P = self.cls
736 self.assertEqual(P('c:a/b'), P('c:a/b'))
737 self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))
738 self.assertNotEqual(P('c:a/b'), P('d:a/b'))
739 self.assertNotEqual(P('c:a/b'), P('c:/a/b'))
740 self.assertNotEqual(P('/a/b'), P('c:/a/b'))
741 # Case-insensitivity
742 self.assertEqual(P('a/B'), P('A/b'))
743 self.assertEqual(P('C:a/B'), P('c:A/b'))
744 self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))
745
746 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100747 P = self.cls
748 with self.assertRaises(ValueError):
749 P('/a/b').as_uri()
750 with self.assertRaises(ValueError):
751 P('c:a/b').as_uri()
752 self.assertEqual(P('c:/').as_uri(), 'file:///c:/')
753 self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')
754 self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')
755 self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')
756 self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')
757 self.assertEqual(P('//some/share/a/b.c').as_uri(),
758 'file://some/share/a/b.c')
759 self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),
760 'file://some/share/a/b%25%23c%C3%A9')
761
762 def test_match_common(self):
763 P = self.cls
764 # Absolute patterns
765 self.assertTrue(P('c:/b.py').match('/*.py'))
766 self.assertTrue(P('c:/b.py').match('c:*.py'))
767 self.assertTrue(P('c:/b.py').match('c:/*.py'))
768 self.assertFalse(P('d:/b.py').match('c:/*.py')) # wrong drive
769 self.assertFalse(P('b.py').match('/*.py'))
770 self.assertFalse(P('b.py').match('c:*.py'))
771 self.assertFalse(P('b.py').match('c:/*.py'))
772 self.assertFalse(P('c:b.py').match('/*.py'))
773 self.assertFalse(P('c:b.py').match('c:/*.py'))
774 self.assertFalse(P('/b.py').match('c:*.py'))
775 self.assertFalse(P('/b.py').match('c:/*.py'))
776 # UNC patterns
777 self.assertTrue(P('//some/share/a.py').match('/*.py'))
778 self.assertTrue(P('//some/share/a.py').match('//some/share/*.py'))
779 self.assertFalse(P('//other/share/a.py').match('//some/share/*.py'))
780 self.assertFalse(P('//some/share/a/b.py').match('//some/share/*.py'))
781 # Case-insensitivity
782 self.assertTrue(P('B.py').match('b.PY'))
783 self.assertTrue(P('c:/a/B.Py').match('C:/A/*.pY'))
784 self.assertTrue(P('//Some/Share/B.Py').match('//somE/sharE/*.pY'))
785
786 def test_ordering_common(self):
787 # Case-insensitivity
788 def assertOrderedEqual(a, b):
789 self.assertLessEqual(a, b)
790 self.assertGreaterEqual(b, a)
791 P = self.cls
792 p = P('c:A/b')
793 q = P('C:a/B')
794 assertOrderedEqual(p, q)
795 self.assertFalse(p < q)
796 self.assertFalse(p > q)
797 p = P('//some/Share/A/b')
798 q = P('//Some/SHARE/a/B')
799 assertOrderedEqual(p, q)
800 self.assertFalse(p < q)
801 self.assertFalse(p > q)
802
803 def test_parts(self):
804 P = self.cls
805 p = P('c:a/b')
806 parts = p.parts
807 self.assertEqual(parts, ('c:', 'a', 'b'))
808 p = P('c:/a/b')
809 parts = p.parts
810 self.assertEqual(parts, ('c:\\', 'a', 'b'))
811 p = P('//a/b/c/d')
812 parts = p.parts
813 self.assertEqual(parts, ('\\\\a\\b\\', 'c', 'd'))
814
815 def test_parent(self):
816 # Anchored
817 P = self.cls
818 p = P('z:a/b/c')
819 self.assertEqual(p.parent, P('z:a/b'))
820 self.assertEqual(p.parent.parent, P('z:a'))
821 self.assertEqual(p.parent.parent.parent, P('z:'))
822 self.assertEqual(p.parent.parent.parent.parent, P('z:'))
823 p = P('z:/a/b/c')
824 self.assertEqual(p.parent, P('z:/a/b'))
825 self.assertEqual(p.parent.parent, P('z:/a'))
826 self.assertEqual(p.parent.parent.parent, P('z:/'))
827 self.assertEqual(p.parent.parent.parent.parent, P('z:/'))
828 p = P('//a/b/c/d')
829 self.assertEqual(p.parent, P('//a/b/c'))
830 self.assertEqual(p.parent.parent, P('//a/b'))
831 self.assertEqual(p.parent.parent.parent, P('//a/b'))
832
833 def test_parents(self):
834 # Anchored
835 P = self.cls
836 p = P('z:a/b/')
837 par = p.parents
838 self.assertEqual(len(par), 2)
839 self.assertEqual(par[0], P('z:a'))
840 self.assertEqual(par[1], P('z:'))
841 self.assertEqual(list(par), [P('z:a'), P('z:')])
842 with self.assertRaises(IndexError):
843 par[2]
844 p = P('z:/a/b/')
845 par = p.parents
846 self.assertEqual(len(par), 2)
847 self.assertEqual(par[0], P('z:/a'))
848 self.assertEqual(par[1], P('z:/'))
849 self.assertEqual(list(par), [P('z:/a'), P('z:/')])
850 with self.assertRaises(IndexError):
851 par[2]
852 p = P('//a/b/c/d')
853 par = p.parents
854 self.assertEqual(len(par), 2)
855 self.assertEqual(par[0], P('//a/b/c'))
856 self.assertEqual(par[1], P('//a/b'))
857 self.assertEqual(list(par), [P('//a/b/c'), P('//a/b')])
858 with self.assertRaises(IndexError):
859 par[2]
860
861 def test_drive(self):
862 P = self.cls
863 self.assertEqual(P('c:').drive, 'c:')
864 self.assertEqual(P('c:a/b').drive, 'c:')
865 self.assertEqual(P('c:/').drive, 'c:')
866 self.assertEqual(P('c:/a/b/').drive, 'c:')
867 self.assertEqual(P('//a/b').drive, '\\\\a\\b')
868 self.assertEqual(P('//a/b/').drive, '\\\\a\\b')
869 self.assertEqual(P('//a/b/c/d').drive, '\\\\a\\b')
870
871 def test_root(self):
872 P = self.cls
873 self.assertEqual(P('c:').root, '')
874 self.assertEqual(P('c:a/b').root, '')
875 self.assertEqual(P('c:/').root, '\\')
876 self.assertEqual(P('c:/a/b/').root, '\\')
877 self.assertEqual(P('//a/b').root, '\\')
878 self.assertEqual(P('//a/b/').root, '\\')
879 self.assertEqual(P('//a/b/c/d').root, '\\')
880
881 def test_anchor(self):
882 P = self.cls
883 self.assertEqual(P('c:').anchor, 'c:')
884 self.assertEqual(P('c:a/b').anchor, 'c:')
885 self.assertEqual(P('c:/').anchor, 'c:\\')
886 self.assertEqual(P('c:/a/b/').anchor, 'c:\\')
887 self.assertEqual(P('//a/b').anchor, '\\\\a\\b\\')
888 self.assertEqual(P('//a/b/').anchor, '\\\\a\\b\\')
889 self.assertEqual(P('//a/b/c/d').anchor, '\\\\a\\b\\')
890
891 def test_name(self):
892 P = self.cls
893 self.assertEqual(P('c:').name, '')
894 self.assertEqual(P('c:/').name, '')
895 self.assertEqual(P('c:a/b').name, 'b')
896 self.assertEqual(P('c:/a/b').name, 'b')
897 self.assertEqual(P('c:a/b.py').name, 'b.py')
898 self.assertEqual(P('c:/a/b.py').name, 'b.py')
899 self.assertEqual(P('//My.py/Share.php').name, '')
900 self.assertEqual(P('//My.py/Share.php/a/b').name, 'b')
901
902 def test_suffix(self):
903 P = self.cls
904 self.assertEqual(P('c:').suffix, '')
905 self.assertEqual(P('c:/').suffix, '')
906 self.assertEqual(P('c:a/b').suffix, '')
907 self.assertEqual(P('c:/a/b').suffix, '')
908 self.assertEqual(P('c:a/b.py').suffix, '.py')
909 self.assertEqual(P('c:/a/b.py').suffix, '.py')
910 self.assertEqual(P('c:a/.hgrc').suffix, '')
911 self.assertEqual(P('c:/a/.hgrc').suffix, '')
912 self.assertEqual(P('c:a/.hg.rc').suffix, '.rc')
913 self.assertEqual(P('c:/a/.hg.rc').suffix, '.rc')
914 self.assertEqual(P('c:a/b.tar.gz').suffix, '.gz')
915 self.assertEqual(P('c:/a/b.tar.gz').suffix, '.gz')
916 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffix, '')
917 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffix, '')
918 self.assertEqual(P('//My.py/Share.php').suffix, '')
919 self.assertEqual(P('//My.py/Share.php/a/b').suffix, '')
920
921 def test_suffixes(self):
922 P = self.cls
923 self.assertEqual(P('c:').suffixes, [])
924 self.assertEqual(P('c:/').suffixes, [])
925 self.assertEqual(P('c:a/b').suffixes, [])
926 self.assertEqual(P('c:/a/b').suffixes, [])
927 self.assertEqual(P('c:a/b.py').suffixes, ['.py'])
928 self.assertEqual(P('c:/a/b.py').suffixes, ['.py'])
929 self.assertEqual(P('c:a/.hgrc').suffixes, [])
930 self.assertEqual(P('c:/a/.hgrc').suffixes, [])
931 self.assertEqual(P('c:a/.hg.rc').suffixes, ['.rc'])
932 self.assertEqual(P('c:/a/.hg.rc').suffixes, ['.rc'])
933 self.assertEqual(P('c:a/b.tar.gz').suffixes, ['.tar', '.gz'])
934 self.assertEqual(P('c:/a/b.tar.gz').suffixes, ['.tar', '.gz'])
935 self.assertEqual(P('//My.py/Share.php').suffixes, [])
936 self.assertEqual(P('//My.py/Share.php/a/b').suffixes, [])
937 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffixes, [])
938 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffixes, [])
939
940 def test_stem(self):
941 P = self.cls
942 self.assertEqual(P('c:').stem, '')
943 self.assertEqual(P('c:.').stem, '')
944 self.assertEqual(P('c:..').stem, '..')
945 self.assertEqual(P('c:/').stem, '')
946 self.assertEqual(P('c:a/b').stem, 'b')
947 self.assertEqual(P('c:a/b.py').stem, 'b')
948 self.assertEqual(P('c:a/.hgrc').stem, '.hgrc')
949 self.assertEqual(P('c:a/.hg.rc').stem, '.hg')
950 self.assertEqual(P('c:a/b.tar.gz').stem, 'b.tar')
951 self.assertEqual(P('c:a/Some name. Ending with a dot.').stem,
952 'Some name. Ending with a dot.')
953
954 def test_with_name(self):
955 P = self.cls
956 self.assertEqual(P('c:a/b').with_name('d.xml'), P('c:a/d.xml'))
957 self.assertEqual(P('c:/a/b').with_name('d.xml'), P('c:/a/d.xml'))
958 self.assertEqual(P('c:a/Dot ending.').with_name('d.xml'), P('c:a/d.xml'))
959 self.assertEqual(P('c:/a/Dot ending.').with_name('d.xml'), P('c:/a/d.xml'))
960 self.assertRaises(ValueError, P('c:').with_name, 'd.xml')
961 self.assertRaises(ValueError, P('c:/').with_name, 'd.xml')
962 self.assertRaises(ValueError, P('//My/Share').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400963 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:')
964 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:e')
965 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:/e')
966 self.assertRaises(ValueError, P('c:a/b').with_name, '//My/Share')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100967
968 def test_with_suffix(self):
969 P = self.cls
970 self.assertEqual(P('c:a/b').with_suffix('.gz'), P('c:a/b.gz'))
971 self.assertEqual(P('c:/a/b').with_suffix('.gz'), P('c:/a/b.gz'))
972 self.assertEqual(P('c:a/b.py').with_suffix('.gz'), P('c:a/b.gz'))
973 self.assertEqual(P('c:/a/b.py').with_suffix('.gz'), P('c:/a/b.gz'))
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100974 # Path doesn't have a "filename" component
Antoine Pitrou31119e42013-11-22 17:38:12 +0100975 self.assertRaises(ValueError, P('').with_suffix, '.gz')
976 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
977 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
978 self.assertRaises(ValueError, P('//My/Share').with_suffix, '.gz')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100979 # Invalid suffix
980 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'gz')
981 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/')
982 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\')
983 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:')
984 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/.gz')
985 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\.gz')
986 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:.gz')
987 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c/d')
988 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c\\d')
989 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c/d')
990 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c\\d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100991
992 def test_relative_to(self):
993 P = self.cls
Antoine Pitrou156b3612013-12-28 19:49:04 +0100994 p = P('C:Foo/Bar')
995 self.assertEqual(p.relative_to(P('c:')), P('Foo/Bar'))
996 self.assertEqual(p.relative_to('c:'), P('Foo/Bar'))
997 self.assertEqual(p.relative_to(P('c:foO')), P('Bar'))
998 self.assertEqual(p.relative_to('c:foO'), P('Bar'))
999 self.assertEqual(p.relative_to('c:foO/'), P('Bar'))
1000 self.assertEqual(p.relative_to(P('c:foO/baR')), P())
1001 self.assertEqual(p.relative_to('c:foO/baR'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001002 # Unrelated paths
1003 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +01001004 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001005 self.assertRaises(ValueError, p.relative_to, P('d:'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001006 self.assertRaises(ValueError, p.relative_to, P('/'))
1007 self.assertRaises(ValueError, p.relative_to, P('Foo'))
1008 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1009 self.assertRaises(ValueError, p.relative_to, P('C:/Foo'))
1010 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Bar/Baz'))
1011 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Baz'))
1012 p = P('C:/Foo/Bar')
1013 self.assertEqual(p.relative_to(P('c:')), P('/Foo/Bar'))
1014 self.assertEqual(p.relative_to('c:'), P('/Foo/Bar'))
1015 self.assertEqual(str(p.relative_to(P('c:'))), '\\Foo\\Bar')
1016 self.assertEqual(str(p.relative_to('c:')), '\\Foo\\Bar')
1017 self.assertEqual(p.relative_to(P('c:/')), P('Foo/Bar'))
1018 self.assertEqual(p.relative_to('c:/'), P('Foo/Bar'))
1019 self.assertEqual(p.relative_to(P('c:/foO')), P('Bar'))
1020 self.assertEqual(p.relative_to('c:/foO'), P('Bar'))
1021 self.assertEqual(p.relative_to('c:/foO/'), P('Bar'))
1022 self.assertEqual(p.relative_to(P('c:/foO/baR')), P())
1023 self.assertEqual(p.relative_to('c:/foO/baR'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001024 # Unrelated paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001025 self.assertRaises(ValueError, p.relative_to, P('C:/Baz'))
1026 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Bar/Baz'))
1027 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Baz'))
1028 self.assertRaises(ValueError, p.relative_to, P('C:Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001029 self.assertRaises(ValueError, p.relative_to, P('d:'))
1030 self.assertRaises(ValueError, p.relative_to, P('d:/'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001031 self.assertRaises(ValueError, p.relative_to, P('/'))
1032 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1033 self.assertRaises(ValueError, p.relative_to, P('//C/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001034 # UNC paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001035 p = P('//Server/Share/Foo/Bar')
1036 self.assertEqual(p.relative_to(P('//sErver/sHare')), P('Foo/Bar'))
1037 self.assertEqual(p.relative_to('//sErver/sHare'), P('Foo/Bar'))
1038 self.assertEqual(p.relative_to('//sErver/sHare/'), P('Foo/Bar'))
1039 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo')), P('Bar'))
1040 self.assertEqual(p.relative_to('//sErver/sHare/Foo'), P('Bar'))
1041 self.assertEqual(p.relative_to('//sErver/sHare/Foo/'), P('Bar'))
1042 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo/Bar')), P())
1043 self.assertEqual(p.relative_to('//sErver/sHare/Foo/Bar'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001044 # Unrelated paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001045 self.assertRaises(ValueError, p.relative_to, P('/Server/Share/Foo'))
1046 self.assertRaises(ValueError, p.relative_to, P('c:/Server/Share/Foo'))
1047 self.assertRaises(ValueError, p.relative_to, P('//z/Share/Foo'))
1048 self.assertRaises(ValueError, p.relative_to, P('//Server/z/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001049
1050 def test_is_absolute(self):
1051 P = self.cls
1052 # Under NT, only paths with both a drive and a root are absolute
1053 self.assertFalse(P().is_absolute())
1054 self.assertFalse(P('a').is_absolute())
1055 self.assertFalse(P('a/b/').is_absolute())
1056 self.assertFalse(P('/').is_absolute())
1057 self.assertFalse(P('/a').is_absolute())
1058 self.assertFalse(P('/a/b/').is_absolute())
1059 self.assertFalse(P('c:').is_absolute())
1060 self.assertFalse(P('c:a').is_absolute())
1061 self.assertFalse(P('c:a/b/').is_absolute())
1062 self.assertTrue(P('c:/').is_absolute())
1063 self.assertTrue(P('c:/a').is_absolute())
1064 self.assertTrue(P('c:/a/b/').is_absolute())
1065 # UNC paths are absolute by definition
1066 self.assertTrue(P('//a/b').is_absolute())
1067 self.assertTrue(P('//a/b/').is_absolute())
1068 self.assertTrue(P('//a/b/c').is_absolute())
1069 self.assertTrue(P('//a/b/c/d').is_absolute())
1070
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001071 def test_join(self):
1072 P = self.cls
1073 p = P('C:/a/b')
1074 pp = p.joinpath('x/y')
1075 self.assertEqual(pp, P('C:/a/b/x/y'))
1076 pp = p.joinpath('/x/y')
1077 self.assertEqual(pp, P('C:/x/y'))
1078 # Joining with a different drive => the first path is ignored, even
1079 # if the second path is relative.
1080 pp = p.joinpath('D:x/y')
1081 self.assertEqual(pp, P('D:x/y'))
1082 pp = p.joinpath('D:/x/y')
1083 self.assertEqual(pp, P('D:/x/y'))
1084 pp = p.joinpath('//host/share/x/y')
1085 self.assertEqual(pp, P('//host/share/x/y'))
1086 # Joining with the same drive => the first path is appended to if
1087 # the second path is relative.
1088 pp = p.joinpath('c:x/y')
1089 self.assertEqual(pp, P('C:/a/b/x/y'))
1090 pp = p.joinpath('c:/x/y')
1091 self.assertEqual(pp, P('C:/x/y'))
1092
1093 def test_div(self):
1094 # Basically the same as joinpath()
1095 P = self.cls
1096 p = P('C:/a/b')
1097 self.assertEqual(p / 'x/y', P('C:/a/b/x/y'))
1098 self.assertEqual(p / 'x' / 'y', P('C:/a/b/x/y'))
1099 self.assertEqual(p / '/x/y', P('C:/x/y'))
1100 self.assertEqual(p / '/x' / 'y', P('C:/x/y'))
1101 # Joining with a different drive => the first path is ignored, even
1102 # if the second path is relative.
1103 self.assertEqual(p / 'D:x/y', P('D:x/y'))
1104 self.assertEqual(p / 'D:' / 'x/y', P('D:x/y'))
1105 self.assertEqual(p / 'D:/x/y', P('D:/x/y'))
1106 self.assertEqual(p / 'D:' / '/x/y', P('D:/x/y'))
1107 self.assertEqual(p / '//host/share/x/y', P('//host/share/x/y'))
1108 # Joining with the same drive => the first path is appended to if
1109 # the second path is relative.
Serhiy Storchaka010ff582013-12-06 17:25:51 +02001110 self.assertEqual(p / 'c:x/y', P('C:/a/b/x/y'))
1111 self.assertEqual(p / 'c:/x/y', P('C:/x/y'))
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001112
Antoine Pitrou31119e42013-11-22 17:38:12 +01001113 def test_is_reserved(self):
1114 P = self.cls
1115 self.assertIs(False, P('').is_reserved())
1116 self.assertIs(False, P('/').is_reserved())
1117 self.assertIs(False, P('/foo/bar').is_reserved())
1118 self.assertIs(True, P('con').is_reserved())
1119 self.assertIs(True, P('NUL').is_reserved())
1120 self.assertIs(True, P('NUL.txt').is_reserved())
1121 self.assertIs(True, P('com1').is_reserved())
1122 self.assertIs(True, P('com9.bar').is_reserved())
1123 self.assertIs(False, P('bar.com9').is_reserved())
1124 self.assertIs(True, P('lpt1').is_reserved())
1125 self.assertIs(True, P('lpt9.bar').is_reserved())
1126 self.assertIs(False, P('bar.lpt9').is_reserved())
1127 # Only the last component matters
1128 self.assertIs(False, P('c:/NUL/con/baz').is_reserved())
1129 # UNC paths are never reserved
1130 self.assertIs(False, P('//my/share/nul/con/aux').is_reserved())
1131
Antoine Pitrou31119e42013-11-22 17:38:12 +01001132class PurePathTest(_BasePurePathTest, unittest.TestCase):
1133 cls = pathlib.PurePath
1134
1135 def test_concrete_class(self):
1136 p = self.cls('a')
1137 self.assertIs(type(p),
1138 pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath)
1139
1140 def test_different_flavours_unequal(self):
1141 p = pathlib.PurePosixPath('a')
1142 q = pathlib.PureWindowsPath('a')
1143 self.assertNotEqual(p, q)
1144
1145 def test_different_flavours_unordered(self):
1146 p = pathlib.PurePosixPath('a')
1147 q = pathlib.PureWindowsPath('a')
1148 with self.assertRaises(TypeError):
1149 p < q
1150 with self.assertRaises(TypeError):
1151 p <= q
1152 with self.assertRaises(TypeError):
1153 p > q
1154 with self.assertRaises(TypeError):
1155 p >= q
1156
1157
1158#
1159# Tests for the concrete classes
1160#
1161
1162# Make sure any symbolic links in the base test path are resolved
1163BASE = os.path.realpath(TESTFN)
1164join = lambda *x: os.path.join(BASE, *x)
1165rel_join = lambda *x: os.path.join(TESTFN, *x)
1166
1167def symlink_skip_reason():
1168 if not pathlib.supports_symlinks:
1169 return "no system support for symlinks"
1170 try:
1171 os.symlink(__file__, BASE)
1172 except OSError as e:
1173 return str(e)
1174 else:
1175 support.unlink(BASE)
1176 return None
1177
1178symlink_skip_reason = symlink_skip_reason()
1179
1180only_nt = unittest.skipIf(os.name != 'nt',
1181 'test requires a Windows-compatible system')
1182only_posix = unittest.skipIf(os.name == 'nt',
1183 'test requires a POSIX-compatible system')
1184with_symlinks = unittest.skipIf(symlink_skip_reason, symlink_skip_reason)
1185
1186
1187@only_posix
1188class PosixPathAsPureTest(PurePosixPathTest):
1189 cls = pathlib.PosixPath
1190
1191@only_nt
1192class WindowsPathAsPureTest(PureWindowsPathTest):
1193 cls = pathlib.WindowsPath
1194
Victor Stinnerd7569632016-03-11 22:53:00 +01001195 def test_owner(self):
1196 P = self.cls
1197 with self.assertRaises(NotImplementedError):
1198 P('c:/').owner()
1199
1200 def test_group(self):
1201 P = self.cls
1202 with self.assertRaises(NotImplementedError):
1203 P('c:/').group()
1204
Antoine Pitrou31119e42013-11-22 17:38:12 +01001205
1206class _BasePathTest(object):
1207 """Tests for the FS-accessing functionalities of the Path classes."""
1208
1209 # (BASE)
1210 # |
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001211 # |-- brokenLink -> non-existing
1212 # |-- dirA
1213 # | `-- linkC -> ../dirB
1214 # |-- dirB
1215 # | |-- fileB
1216 # | `-- linkD -> ../dirB
1217 # |-- dirC
1218 # | |-- dirD
1219 # | | `-- fileD
1220 # | `-- fileC
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001221 # |-- dirE # No permissions
Antoine Pitrou31119e42013-11-22 17:38:12 +01001222 # |-- fileA
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001223 # |-- linkA -> fileA
1224 # `-- linkB -> dirB
Antoine Pitrou31119e42013-11-22 17:38:12 +01001225 #
1226
1227 def setUp(self):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001228 def cleanup():
1229 os.chmod(join('dirE'), 0o777)
1230 support.rmtree(BASE)
1231 self.addCleanup(cleanup)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001232 os.mkdir(BASE)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001233 os.mkdir(join('dirA'))
1234 os.mkdir(join('dirB'))
1235 os.mkdir(join('dirC'))
1236 os.mkdir(join('dirC', 'dirD'))
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001237 os.mkdir(join('dirE'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001238 with open(join('fileA'), 'wb') as f:
1239 f.write(b"this is file A\n")
1240 with open(join('dirB', 'fileB'), 'wb') as f:
1241 f.write(b"this is file B\n")
1242 with open(join('dirC', 'fileC'), 'wb') as f:
1243 f.write(b"this is file C\n")
1244 with open(join('dirC', 'dirD', 'fileD'), 'wb') as f:
1245 f.write(b"this is file D\n")
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001246 os.chmod(join('dirE'), 0)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001247 if not symlink_skip_reason:
Antoine Pitrou31119e42013-11-22 17:38:12 +01001248 # Relative symlinks
1249 os.symlink('fileA', join('linkA'))
1250 os.symlink('non-existing', join('brokenLink'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001251 self.dirlink('dirB', join('linkB'))
1252 self.dirlink(os.path.join('..', 'dirB'), join('dirA', 'linkC'))
Guido van Rossum69bfb152016-01-06 10:31:33 -08001253 # This one goes upwards, creating a loop
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001254 self.dirlink(os.path.join('..', 'dirB'), join('dirB', 'linkD'))
1255
1256 if os.name == 'nt':
1257 # Workaround for http://bugs.python.org/issue13772
1258 def dirlink(self, src, dest):
1259 os.symlink(src, dest, target_is_directory=True)
1260 else:
1261 def dirlink(self, src, dest):
1262 os.symlink(src, dest)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001263
1264 def assertSame(self, path_a, path_b):
1265 self.assertTrue(os.path.samefile(str(path_a), str(path_b)),
1266 "%r and %r don't point to the same file" %
1267 (path_a, path_b))
1268
1269 def assertFileNotFound(self, func, *args, **kwargs):
1270 with self.assertRaises(FileNotFoundError) as cm:
1271 func(*args, **kwargs)
1272 self.assertEqual(cm.exception.errno, errno.ENOENT)
1273
1274 def _test_cwd(self, p):
1275 q = self.cls(os.getcwd())
1276 self.assertEqual(p, q)
1277 self.assertEqual(str(p), str(q))
1278 self.assertIs(type(p), type(q))
1279 self.assertTrue(p.is_absolute())
1280
1281 def test_cwd(self):
1282 p = self.cls.cwd()
1283 self._test_cwd(p)
1284
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001285 def _test_home(self, p):
1286 q = self.cls(os.path.expanduser('~'))
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_home(self):
1293 p = self.cls.home()
1294 self._test_home(p)
1295
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001296 def test_samefile(self):
1297 fileA_path = os.path.join(BASE, 'fileA')
1298 fileB_path = os.path.join(BASE, 'dirB', 'fileB')
1299 p = self.cls(fileA_path)
1300 pp = self.cls(fileA_path)
1301 q = self.cls(fileB_path)
1302 self.assertTrue(p.samefile(fileA_path))
1303 self.assertTrue(p.samefile(pp))
1304 self.assertFalse(p.samefile(fileB_path))
1305 self.assertFalse(p.samefile(q))
1306 # Test the non-existent file case
1307 non_existent = os.path.join(BASE, 'foo')
1308 r = self.cls(non_existent)
1309 self.assertRaises(FileNotFoundError, p.samefile, r)
1310 self.assertRaises(FileNotFoundError, p.samefile, non_existent)
1311 self.assertRaises(FileNotFoundError, r.samefile, p)
1312 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1313 self.assertRaises(FileNotFoundError, r.samefile, r)
1314 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1315
Antoine Pitrou31119e42013-11-22 17:38:12 +01001316 def test_empty_path(self):
1317 # The empty path points to '.'
1318 p = self.cls('')
1319 self.assertEqual(p.stat(), os.stat('.'))
1320
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001321 def test_expanduser_common(self):
1322 P = self.cls
1323 p = P('~')
1324 self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))
1325 p = P('foo')
1326 self.assertEqual(p.expanduser(), p)
1327 p = P('/~')
1328 self.assertEqual(p.expanduser(), p)
1329 p = P('../~')
1330 self.assertEqual(p.expanduser(), p)
1331 p = P(P('').absolute().anchor) / '~'
1332 self.assertEqual(p.expanduser(), p)
1333
Antoine Pitrou31119e42013-11-22 17:38:12 +01001334 def test_exists(self):
1335 P = self.cls
1336 p = P(BASE)
1337 self.assertIs(True, p.exists())
1338 self.assertIs(True, (p / 'dirA').exists())
1339 self.assertIs(True, (p / 'fileA').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001340 self.assertIs(False, (p / 'fileA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001341 if not symlink_skip_reason:
1342 self.assertIs(True, (p / 'linkA').exists())
1343 self.assertIs(True, (p / 'linkB').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001344 self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1345 self.assertIs(False, (p / 'linkA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001346 self.assertIs(False, (p / 'foo').exists())
1347 self.assertIs(False, P('/xyzzy').exists())
1348
1349 def test_open_common(self):
1350 p = self.cls(BASE)
1351 with (p / 'fileA').open('r') as f:
1352 self.assertIsInstance(f, io.TextIOBase)
1353 self.assertEqual(f.read(), "this is file A\n")
1354 with (p / 'fileA').open('rb') as f:
1355 self.assertIsInstance(f, io.BufferedIOBase)
1356 self.assertEqual(f.read().strip(), b"this is file A")
1357 with (p / 'fileA').open('rb', buffering=0) as f:
1358 self.assertIsInstance(f, io.RawIOBase)
1359 self.assertEqual(f.read().strip(), b"this is file A")
1360
Georg Brandlea683982014-10-01 19:12:33 +02001361 def test_read_write_bytes(self):
1362 p = self.cls(BASE)
1363 (p / 'fileA').write_bytes(b'abcdefg')
1364 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1365 # check that trying to write str does not truncate the file
1366 self.assertRaises(TypeError, (p / 'fileA').write_bytes, 'somestr')
1367 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1368
1369 def test_read_write_text(self):
1370 p = self.cls(BASE)
1371 (p / 'fileA').write_text('äbcdefg', encoding='latin-1')
1372 self.assertEqual((p / 'fileA').read_text(
1373 encoding='utf-8', errors='ignore'), 'bcdefg')
1374 # check that trying to write bytes does not truncate the file
1375 self.assertRaises(TypeError, (p / 'fileA').write_text, b'somebytes')
1376 self.assertEqual((p / 'fileA').read_text(encoding='latin-1'), 'äbcdefg')
1377
Antoine Pitrou31119e42013-11-22 17:38:12 +01001378 def test_iterdir(self):
1379 P = self.cls
1380 p = P(BASE)
1381 it = p.iterdir()
1382 paths = set(it)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001383 expected = ['dirA', 'dirB', 'dirC', 'dirE', 'fileA']
Antoine Pitrou31119e42013-11-22 17:38:12 +01001384 if not symlink_skip_reason:
1385 expected += ['linkA', 'linkB', 'brokenLink']
1386 self.assertEqual(paths, { P(BASE, q) for q in expected })
1387
1388 @with_symlinks
1389 def test_iterdir_symlink(self):
1390 # __iter__ on a symlink to a directory
1391 P = self.cls
1392 p = P(BASE, 'linkB')
1393 paths = set(p.iterdir())
1394 expected = { P(BASE, 'linkB', q) for q in ['fileB', 'linkD'] }
1395 self.assertEqual(paths, expected)
1396
1397 def test_iterdir_nodir(self):
1398 # __iter__ on something that is not a directory
1399 p = self.cls(BASE, 'fileA')
1400 with self.assertRaises(OSError) as cm:
1401 next(p.iterdir())
1402 # ENOENT or EINVAL under Windows, ENOTDIR otherwise
1403 # (see issue #12802)
1404 self.assertIn(cm.exception.errno, (errno.ENOTDIR,
1405 errno.ENOENT, errno.EINVAL))
1406
1407 def test_glob_common(self):
1408 def _check(glob, expected):
1409 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1410 P = self.cls
1411 p = P(BASE)
1412 it = p.glob("fileA")
1413 self.assertIsInstance(it, collections.Iterator)
1414 _check(it, ["fileA"])
1415 _check(p.glob("fileB"), [])
1416 _check(p.glob("dir*/file*"), ["dirB/fileB", "dirC/fileC"])
1417 if symlink_skip_reason:
1418 _check(p.glob("*A"), ['dirA', 'fileA'])
1419 else:
1420 _check(p.glob("*A"), ['dirA', 'fileA', 'linkA'])
1421 if symlink_skip_reason:
1422 _check(p.glob("*B/*"), ['dirB/fileB'])
1423 else:
1424 _check(p.glob("*B/*"), ['dirB/fileB', 'dirB/linkD',
1425 'linkB/fileB', 'linkB/linkD'])
1426 if symlink_skip_reason:
1427 _check(p.glob("*/fileB"), ['dirB/fileB'])
1428 else:
1429 _check(p.glob("*/fileB"), ['dirB/fileB', 'linkB/fileB'])
1430
1431 def test_rglob_common(self):
1432 def _check(glob, expected):
1433 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1434 P = self.cls
1435 p = P(BASE)
1436 it = p.rglob("fileA")
1437 self.assertIsInstance(it, collections.Iterator)
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001438 _check(it, ["fileA"])
1439 _check(p.rglob("fileB"), ["dirB/fileB"])
1440 _check(p.rglob("*/fileA"), [])
Guido van Rossum9c39b672016-01-07 13:12:34 -08001441 if symlink_skip_reason:
1442 _check(p.rglob("*/fileB"), ["dirB/fileB"])
1443 else:
1444 _check(p.rglob("*/fileB"), ["dirB/fileB", "dirB/linkD/fileB",
1445 "linkB/fileB", "dirA/linkC/fileB"])
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001446 _check(p.rglob("file*"), ["fileA", "dirB/fileB",
1447 "dirC/fileC", "dirC/dirD/fileD"])
Antoine Pitrou31119e42013-11-22 17:38:12 +01001448 p = P(BASE, "dirC")
1449 _check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
1450 _check(p.rglob("*/*"), ["dirC/dirD/fileD"])
1451
Guido van Rossum69bfb152016-01-06 10:31:33 -08001452 @with_symlinks
1453 def test_rglob_symlink_loop(self):
1454 # Don't get fooled by symlink loops (Issue #26012)
1455 P = self.cls
1456 p = P(BASE)
1457 given = set(p.rglob('*'))
1458 expect = {'brokenLink',
1459 'dirA', 'dirA/linkC',
1460 'dirB', 'dirB/fileB', 'dirB/linkD',
1461 'dirC', 'dirC/dirD', 'dirC/dirD/fileD', 'dirC/fileC',
1462 'dirE',
1463 'fileA',
1464 'linkA',
1465 'linkB',
1466 }
1467 self.assertEqual(given, {p / x for x in expect})
1468
Antoine Pitrou31119e42013-11-22 17:38:12 +01001469 def test_glob_dotdot(self):
1470 # ".." is not special in globs
1471 P = self.cls
1472 p = P(BASE)
1473 self.assertEqual(set(p.glob("..")), { P(BASE, "..") })
1474 self.assertEqual(set(p.glob("dirA/../file*")), { P(BASE, "dirA/../fileA") })
1475 self.assertEqual(set(p.glob("../xyzzy")), set())
1476
1477 def _check_resolve_relative(self, p, expected):
1478 q = p.resolve()
1479 self.assertEqual(q, expected)
1480
1481 def _check_resolve_absolute(self, p, expected):
1482 q = p.resolve()
1483 self.assertEqual(q, expected)
1484
1485 @with_symlinks
1486 def test_resolve_common(self):
1487 P = self.cls
1488 p = P(BASE, 'foo')
1489 with self.assertRaises(OSError) as cm:
1490 p.resolve()
1491 self.assertEqual(cm.exception.errno, errno.ENOENT)
1492 # These are all relative symlinks
1493 p = P(BASE, 'dirB', 'fileB')
1494 self._check_resolve_relative(p, p)
1495 p = P(BASE, 'linkA')
1496 self._check_resolve_relative(p, P(BASE, 'fileA'))
1497 p = P(BASE, 'dirA', 'linkC', 'fileB')
1498 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1499 p = P(BASE, 'dirB', 'linkD', 'fileB')
1500 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1501 # Now create absolute symlinks
1502 d = tempfile.mkdtemp(suffix='-dirD')
Victor Stinnerec864692014-07-21 19:19:05 +02001503 self.addCleanup(support.rmtree, d)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001504 os.symlink(os.path.join(d), join('dirA', 'linkX'))
1505 os.symlink(join('dirB'), os.path.join(d, 'linkY'))
1506 p = P(BASE, 'dirA', 'linkX', 'linkY', 'fileB')
1507 self._check_resolve_absolute(p, P(BASE, 'dirB', 'fileB'))
1508
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001509 @with_symlinks
1510 def test_resolve_dot(self):
1511 # See https://bitbucket.org/pitrou/pathlib/issue/9/pathresolve-fails-on-complex-symlinks
1512 p = self.cls(BASE)
1513 self.dirlink('.', join('0'))
Antoine Pitroucc157512013-12-03 17:13:13 +01001514 self.dirlink(os.path.join('0', '0'), join('1'))
1515 self.dirlink(os.path.join('1', '1'), join('2'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001516 q = p / '2'
1517 self.assertEqual(q.resolve(), p)
1518
Antoine Pitrou31119e42013-11-22 17:38:12 +01001519 def test_with(self):
1520 p = self.cls(BASE)
1521 it = p.iterdir()
1522 it2 = p.iterdir()
1523 next(it2)
1524 with p:
1525 pass
1526 # I/O operation on closed path
1527 self.assertRaises(ValueError, next, it)
1528 self.assertRaises(ValueError, next, it2)
1529 self.assertRaises(ValueError, p.open)
1530 self.assertRaises(ValueError, p.resolve)
1531 self.assertRaises(ValueError, p.absolute)
1532 self.assertRaises(ValueError, p.__enter__)
1533
1534 def test_chmod(self):
1535 p = self.cls(BASE) / 'fileA'
1536 mode = p.stat().st_mode
1537 # Clear writable bit
1538 new_mode = mode & ~0o222
1539 p.chmod(new_mode)
1540 self.assertEqual(p.stat().st_mode, new_mode)
1541 # Set writable bit
1542 new_mode = mode | 0o222
1543 p.chmod(new_mode)
1544 self.assertEqual(p.stat().st_mode, new_mode)
1545
1546 # XXX also need a test for lchmod
1547
1548 def test_stat(self):
1549 p = self.cls(BASE) / 'fileA'
1550 st = p.stat()
1551 self.assertEqual(p.stat(), st)
1552 # Change file mode by flipping write bit
1553 p.chmod(st.st_mode ^ 0o222)
1554 self.addCleanup(p.chmod, st.st_mode)
1555 self.assertNotEqual(p.stat(), st)
1556
1557 @with_symlinks
1558 def test_lstat(self):
1559 p = self.cls(BASE)/ 'linkA'
1560 st = p.stat()
1561 self.assertNotEqual(st, p.lstat())
1562
1563 def test_lstat_nosymlink(self):
1564 p = self.cls(BASE) / 'fileA'
1565 st = p.stat()
1566 self.assertEqual(st, p.lstat())
1567
1568 @unittest.skipUnless(pwd, "the pwd module is needed for this test")
1569 def test_owner(self):
1570 p = self.cls(BASE) / 'fileA'
1571 uid = p.stat().st_uid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001572 try:
1573 name = pwd.getpwuid(uid).pw_name
1574 except KeyError:
1575 self.skipTest(
1576 "user %d doesn't have an entry in the system database" % uid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001577 self.assertEqual(name, p.owner())
1578
1579 @unittest.skipUnless(grp, "the grp module is needed for this test")
1580 def test_group(self):
1581 p = self.cls(BASE) / 'fileA'
1582 gid = p.stat().st_gid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001583 try:
1584 name = grp.getgrgid(gid).gr_name
1585 except KeyError:
1586 self.skipTest(
1587 "group %d doesn't have an entry in the system database" % gid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001588 self.assertEqual(name, p.group())
1589
1590 def test_unlink(self):
1591 p = self.cls(BASE) / 'fileA'
1592 p.unlink()
1593 self.assertFileNotFound(p.stat)
1594 self.assertFileNotFound(p.unlink)
1595
1596 def test_rmdir(self):
1597 p = self.cls(BASE) / 'dirA'
1598 for q in p.iterdir():
1599 q.unlink()
1600 p.rmdir()
1601 self.assertFileNotFound(p.stat)
1602 self.assertFileNotFound(p.unlink)
1603
1604 def test_rename(self):
1605 P = self.cls(BASE)
1606 p = P / 'fileA'
1607 size = p.stat().st_size
1608 # Renaming to another path
1609 q = P / 'dirA' / 'fileAA'
1610 p.rename(q)
1611 self.assertEqual(q.stat().st_size, size)
1612 self.assertFileNotFound(p.stat)
1613 # Renaming to a str of a relative path
1614 r = rel_join('fileAAA')
1615 q.rename(r)
1616 self.assertEqual(os.stat(r).st_size, size)
1617 self.assertFileNotFound(q.stat)
1618
1619 def test_replace(self):
1620 P = self.cls(BASE)
1621 p = P / 'fileA'
1622 size = p.stat().st_size
1623 # Replacing a non-existing path
1624 q = P / 'dirA' / 'fileAA'
1625 p.replace(q)
1626 self.assertEqual(q.stat().st_size, size)
1627 self.assertFileNotFound(p.stat)
1628 # Replacing another (existing) path
1629 r = rel_join('dirB', 'fileB')
1630 q.replace(r)
1631 self.assertEqual(os.stat(r).st_size, size)
1632 self.assertFileNotFound(q.stat)
1633
1634 def test_touch_common(self):
1635 P = self.cls(BASE)
1636 p = P / 'newfileA'
1637 self.assertFalse(p.exists())
1638 p.touch()
1639 self.assertTrue(p.exists())
Antoine Pitrou0f575642013-11-22 23:20:08 +01001640 st = p.stat()
1641 old_mtime = st.st_mtime
1642 old_mtime_ns = st.st_mtime_ns
Antoine Pitrou31119e42013-11-22 17:38:12 +01001643 # Rewind the mtime sufficiently far in the past to work around
1644 # filesystem-specific timestamp granularity.
1645 os.utime(str(p), (old_mtime - 10, old_mtime - 10))
Antoine Pitroubb6694d2013-11-23 01:32:53 +01001646 # The file mtime should be refreshed by calling touch() again
Antoine Pitrou31119e42013-11-22 17:38:12 +01001647 p.touch()
Antoine Pitrou0f575642013-11-22 23:20:08 +01001648 st = p.stat()
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001649 self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)
1650 self.assertGreaterEqual(st.st_mtime, old_mtime)
Antoine Pitroubb6694d2013-11-23 01:32:53 +01001651 # Now with exist_ok=False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001652 p = P / 'newfileB'
1653 self.assertFalse(p.exists())
1654 p.touch(mode=0o700, exist_ok=False)
1655 self.assertTrue(p.exists())
1656 self.assertRaises(OSError, p.touch, exist_ok=False)
1657
Antoine Pitrou8b784932013-11-23 14:52:39 +01001658 def test_touch_nochange(self):
1659 P = self.cls(BASE)
1660 p = P / 'fileA'
1661 p.touch()
1662 with p.open('rb') as f:
1663 self.assertEqual(f.read().strip(), b"this is file A")
1664
Antoine Pitrou31119e42013-11-22 17:38:12 +01001665 def test_mkdir(self):
1666 P = self.cls(BASE)
1667 p = P / 'newdirA'
1668 self.assertFalse(p.exists())
1669 p.mkdir()
1670 self.assertTrue(p.exists())
1671 self.assertTrue(p.is_dir())
1672 with self.assertRaises(OSError) as cm:
1673 p.mkdir()
1674 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001675
1676 def test_mkdir_parents(self):
1677 # Creating a chain of directories
1678 p = self.cls(BASE, 'newdirB', 'newdirC')
1679 self.assertFalse(p.exists())
1680 with self.assertRaises(OSError) as cm:
1681 p.mkdir()
1682 self.assertEqual(cm.exception.errno, errno.ENOENT)
1683 p.mkdir(parents=True)
1684 self.assertTrue(p.exists())
1685 self.assertTrue(p.is_dir())
1686 with self.assertRaises(OSError) as cm:
1687 p.mkdir(parents=True)
1688 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou0048c982013-12-16 20:22:37 +01001689 # test `mode` arg
1690 mode = stat.S_IMODE(p.stat().st_mode) # default mode
1691 p = self.cls(BASE, 'newdirD', 'newdirE')
1692 p.mkdir(0o555, parents=True)
1693 self.assertTrue(p.exists())
1694 self.assertTrue(p.is_dir())
1695 if os.name != 'nt':
1696 # the directory's permissions follow the mode argument
Gregory P. Smithb599c612014-01-20 01:10:33 -08001697 self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)
Antoine Pitrou0048c982013-12-16 20:22:37 +01001698 # the parent's permissions follow the default process settings
1699 self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001700
Barry Warsaw7c549c42014-08-05 11:28:12 -04001701 def test_mkdir_exist_ok(self):
1702 p = self.cls(BASE, 'dirB')
1703 st_ctime_first = p.stat().st_ctime
1704 self.assertTrue(p.exists())
1705 self.assertTrue(p.is_dir())
1706 with self.assertRaises(FileExistsError) as cm:
1707 p.mkdir()
1708 self.assertEqual(cm.exception.errno, errno.EEXIST)
1709 p.mkdir(exist_ok=True)
1710 self.assertTrue(p.exists())
1711 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1712
1713 def test_mkdir_exist_ok_with_parent(self):
1714 p = self.cls(BASE, 'dirC')
1715 self.assertTrue(p.exists())
1716 with self.assertRaises(FileExistsError) as cm:
1717 p.mkdir()
1718 self.assertEqual(cm.exception.errno, errno.EEXIST)
1719 p = p / 'newdirC'
1720 p.mkdir(parents=True)
1721 st_ctime_first = p.stat().st_ctime
1722 self.assertTrue(p.exists())
1723 with self.assertRaises(FileExistsError) as cm:
1724 p.mkdir(parents=True)
1725 self.assertEqual(cm.exception.errno, errno.EEXIST)
1726 p.mkdir(parents=True, exist_ok=True)
1727 self.assertTrue(p.exists())
1728 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1729
1730 def test_mkdir_with_child_file(self):
1731 p = self.cls(BASE, 'dirB', 'fileB')
1732 self.assertTrue(p.exists())
1733 # An exception is raised when the last path component is an existing
1734 # regular file, regardless of whether exist_ok is true or not.
1735 with self.assertRaises(FileExistsError) as cm:
1736 p.mkdir(parents=True)
1737 self.assertEqual(cm.exception.errno, errno.EEXIST)
1738 with self.assertRaises(FileExistsError) as cm:
1739 p.mkdir(parents=True, exist_ok=True)
1740 self.assertEqual(cm.exception.errno, errno.EEXIST)
1741
1742 def test_mkdir_no_parents_file(self):
1743 p = self.cls(BASE, 'fileA')
1744 self.assertTrue(p.exists())
1745 # An exception is raised when the last path component is an existing
1746 # regular file, regardless of whether exist_ok is true or not.
1747 with self.assertRaises(FileExistsError) as cm:
1748 p.mkdir()
1749 self.assertEqual(cm.exception.errno, errno.EEXIST)
1750 with self.assertRaises(FileExistsError) as cm:
1751 p.mkdir(exist_ok=True)
1752 self.assertEqual(cm.exception.errno, errno.EEXIST)
1753
Antoine Pitrou31119e42013-11-22 17:38:12 +01001754 @with_symlinks
1755 def test_symlink_to(self):
1756 P = self.cls(BASE)
1757 target = P / 'fileA'
1758 # Symlinking a path target
1759 link = P / 'dirA' / 'linkAA'
1760 link.symlink_to(target)
1761 self.assertEqual(link.stat(), target.stat())
1762 self.assertNotEqual(link.lstat(), target.stat())
1763 # Symlinking a str target
1764 link = P / 'dirA' / 'linkAAA'
1765 link.symlink_to(str(target))
1766 self.assertEqual(link.stat(), target.stat())
1767 self.assertNotEqual(link.lstat(), target.stat())
1768 self.assertFalse(link.is_dir())
1769 # Symlinking to a directory
1770 target = P / 'dirB'
1771 link = P / 'dirA' / 'linkAAAA'
1772 link.symlink_to(target, target_is_directory=True)
1773 self.assertEqual(link.stat(), target.stat())
1774 self.assertNotEqual(link.lstat(), target.stat())
1775 self.assertTrue(link.is_dir())
1776 self.assertTrue(list(link.iterdir()))
1777
1778 def test_is_dir(self):
1779 P = self.cls(BASE)
1780 self.assertTrue((P / 'dirA').is_dir())
1781 self.assertFalse((P / 'fileA').is_dir())
1782 self.assertFalse((P / 'non-existing').is_dir())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001783 self.assertFalse((P / 'fileA' / 'bah').is_dir())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001784 if not symlink_skip_reason:
1785 self.assertFalse((P / 'linkA').is_dir())
1786 self.assertTrue((P / 'linkB').is_dir())
1787 self.assertFalse((P/ 'brokenLink').is_dir())
1788
1789 def test_is_file(self):
1790 P = self.cls(BASE)
1791 self.assertTrue((P / 'fileA').is_file())
1792 self.assertFalse((P / 'dirA').is_file())
1793 self.assertFalse((P / 'non-existing').is_file())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001794 self.assertFalse((P / 'fileA' / 'bah').is_file())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001795 if not symlink_skip_reason:
1796 self.assertTrue((P / 'linkA').is_file())
1797 self.assertFalse((P / 'linkB').is_file())
1798 self.assertFalse((P/ 'brokenLink').is_file())
1799
1800 def test_is_symlink(self):
1801 P = self.cls(BASE)
1802 self.assertFalse((P / 'fileA').is_symlink())
1803 self.assertFalse((P / 'dirA').is_symlink())
1804 self.assertFalse((P / 'non-existing').is_symlink())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001805 self.assertFalse((P / 'fileA' / 'bah').is_symlink())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001806 if not symlink_skip_reason:
1807 self.assertTrue((P / 'linkA').is_symlink())
1808 self.assertTrue((P / 'linkB').is_symlink())
1809 self.assertTrue((P/ 'brokenLink').is_symlink())
1810
1811 def test_is_fifo_false(self):
1812 P = self.cls(BASE)
1813 self.assertFalse((P / 'fileA').is_fifo())
1814 self.assertFalse((P / 'dirA').is_fifo())
1815 self.assertFalse((P / 'non-existing').is_fifo())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001816 self.assertFalse((P / 'fileA' / 'bah').is_fifo())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001817
1818 @unittest.skipUnless(hasattr(os, "mkfifo"), "os.mkfifo() required")
1819 def test_is_fifo_true(self):
1820 P = self.cls(BASE, 'myfifo')
1821 os.mkfifo(str(P))
1822 self.assertTrue(P.is_fifo())
1823 self.assertFalse(P.is_socket())
1824 self.assertFalse(P.is_file())
1825
1826 def test_is_socket_false(self):
1827 P = self.cls(BASE)
1828 self.assertFalse((P / 'fileA').is_socket())
1829 self.assertFalse((P / 'dirA').is_socket())
1830 self.assertFalse((P / 'non-existing').is_socket())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001831 self.assertFalse((P / 'fileA' / 'bah').is_socket())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001832
1833 @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required")
1834 def test_is_socket_true(self):
1835 P = self.cls(BASE, 'mysock')
Antoine Pitrou330ce592013-11-22 18:05:06 +01001836 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001837 self.addCleanup(sock.close)
Antoine Pitrou330ce592013-11-22 18:05:06 +01001838 try:
1839 sock.bind(str(P))
1840 except OSError as e:
1841 if "AF_UNIX path too long" in str(e):
1842 self.skipTest("cannot bind Unix socket: " + str(e))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001843 self.assertTrue(P.is_socket())
1844 self.assertFalse(P.is_fifo())
1845 self.assertFalse(P.is_file())
1846
1847 def test_is_block_device_false(self):
1848 P = self.cls(BASE)
1849 self.assertFalse((P / 'fileA').is_block_device())
1850 self.assertFalse((P / 'dirA').is_block_device())
1851 self.assertFalse((P / 'non-existing').is_block_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001852 self.assertFalse((P / 'fileA' / 'bah').is_block_device())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001853
1854 def test_is_char_device_false(self):
1855 P = self.cls(BASE)
1856 self.assertFalse((P / 'fileA').is_char_device())
1857 self.assertFalse((P / 'dirA').is_char_device())
1858 self.assertFalse((P / 'non-existing').is_char_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001859 self.assertFalse((P / 'fileA' / 'bah').is_char_device())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001860
1861 def test_is_char_device_true(self):
1862 # Under Unix, /dev/null should generally be a char device
1863 P = self.cls('/dev/null')
1864 if not P.exists():
1865 self.skipTest("/dev/null required")
1866 self.assertTrue(P.is_char_device())
1867 self.assertFalse(P.is_block_device())
1868 self.assertFalse(P.is_file())
1869
1870 def test_pickling_common(self):
1871 p = self.cls(BASE, 'fileA')
1872 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
1873 dumped = pickle.dumps(p, proto)
1874 pp = pickle.loads(dumped)
1875 self.assertEqual(pp.stat(), p.stat())
1876
1877 def test_parts_interning(self):
1878 P = self.cls
1879 p = P('/usr/bin/foo')
1880 q = P('/usr/local/bin')
1881 # 'usr'
1882 self.assertIs(p.parts[1], q.parts[1])
1883 # 'bin'
1884 self.assertIs(p.parts[2], q.parts[3])
1885
Antoine Pitrouc274fd22013-12-16 19:57:41 +01001886 def _check_complex_symlinks(self, link0_target):
1887 # Test solving a non-looping chain of symlinks (issue #19887)
1888 P = self.cls(BASE)
1889 self.dirlink(os.path.join('link0', 'link0'), join('link1'))
1890 self.dirlink(os.path.join('link1', 'link1'), join('link2'))
1891 self.dirlink(os.path.join('link2', 'link2'), join('link3'))
1892 self.dirlink(link0_target, join('link0'))
1893
1894 # Resolve absolute paths
1895 p = (P / 'link0').resolve()
1896 self.assertEqual(p, P)
1897 self.assertEqual(str(p), BASE)
1898 p = (P / 'link1').resolve()
1899 self.assertEqual(p, P)
1900 self.assertEqual(str(p), BASE)
1901 p = (P / 'link2').resolve()
1902 self.assertEqual(p, P)
1903 self.assertEqual(str(p), BASE)
1904 p = (P / 'link3').resolve()
1905 self.assertEqual(p, P)
1906 self.assertEqual(str(p), BASE)
1907
1908 # Resolve relative paths
1909 old_path = os.getcwd()
1910 os.chdir(BASE)
1911 try:
1912 p = self.cls('link0').resolve()
1913 self.assertEqual(p, P)
1914 self.assertEqual(str(p), BASE)
1915 p = self.cls('link1').resolve()
1916 self.assertEqual(p, P)
1917 self.assertEqual(str(p), BASE)
1918 p = self.cls('link2').resolve()
1919 self.assertEqual(p, P)
1920 self.assertEqual(str(p), BASE)
1921 p = self.cls('link3').resolve()
1922 self.assertEqual(p, P)
1923 self.assertEqual(str(p), BASE)
1924 finally:
1925 os.chdir(old_path)
1926
1927 @with_symlinks
1928 def test_complex_symlinks_absolute(self):
1929 self._check_complex_symlinks(BASE)
1930
1931 @with_symlinks
1932 def test_complex_symlinks_relative(self):
1933 self._check_complex_symlinks('.')
1934
1935 @with_symlinks
1936 def test_complex_symlinks_relative_dot_dot(self):
1937 self._check_complex_symlinks(os.path.join('dirA', '..'))
1938
Antoine Pitrou31119e42013-11-22 17:38:12 +01001939
1940class PathTest(_BasePathTest, unittest.TestCase):
1941 cls = pathlib.Path
1942
1943 def test_concrete_class(self):
1944 p = self.cls('a')
1945 self.assertIs(type(p),
1946 pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath)
1947
1948 def test_unsupported_flavour(self):
1949 if os.name == 'nt':
1950 self.assertRaises(NotImplementedError, pathlib.PosixPath)
1951 else:
1952 self.assertRaises(NotImplementedError, pathlib.WindowsPath)
1953
Berker Peksag4a208e42016-01-30 17:50:48 +02001954 def test_glob_empty_pattern(self):
1955 p = self.cls()
1956 with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
1957 list(p.glob(''))
1958
Antoine Pitrou31119e42013-11-22 17:38:12 +01001959
1960@only_posix
1961class PosixPathTest(_BasePathTest, unittest.TestCase):
1962 cls = pathlib.PosixPath
1963
1964 def _check_symlink_loop(self, *args):
1965 path = self.cls(*args)
1966 with self.assertRaises(RuntimeError):
1967 print(path.resolve())
1968
1969 def test_open_mode(self):
1970 old_mask = os.umask(0)
1971 self.addCleanup(os.umask, old_mask)
1972 p = self.cls(BASE)
1973 with (p / 'new_file').open('wb'):
1974 pass
1975 st = os.stat(join('new_file'))
1976 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
1977 os.umask(0o022)
1978 with (p / 'other_new_file').open('wb'):
1979 pass
1980 st = os.stat(join('other_new_file'))
1981 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
1982
1983 def test_touch_mode(self):
1984 old_mask = os.umask(0)
1985 self.addCleanup(os.umask, old_mask)
1986 p = self.cls(BASE)
1987 (p / 'new_file').touch()
1988 st = os.stat(join('new_file'))
1989 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
1990 os.umask(0o022)
1991 (p / 'other_new_file').touch()
1992 st = os.stat(join('other_new_file'))
1993 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
1994 (p / 'masked_new_file').touch(mode=0o750)
1995 st = os.stat(join('masked_new_file'))
1996 self.assertEqual(stat.S_IMODE(st.st_mode), 0o750)
1997
1998 @with_symlinks
1999 def test_resolve_loop(self):
2000 # Loop detection for broken symlinks under POSIX
Antoine Pitrou31119e42013-11-22 17:38:12 +01002001 # Loops with relative symlinks
2002 os.symlink('linkX/inside', join('linkX'))
2003 self._check_symlink_loop(BASE, 'linkX')
2004 os.symlink('linkY', join('linkY'))
2005 self._check_symlink_loop(BASE, 'linkY')
2006 os.symlink('linkZ/../linkZ', join('linkZ'))
2007 self._check_symlink_loop(BASE, 'linkZ')
2008 # Loops with absolute symlinks
2009 os.symlink(join('linkU/inside'), join('linkU'))
2010 self._check_symlink_loop(BASE, 'linkU')
2011 os.symlink(join('linkV'), join('linkV'))
2012 self._check_symlink_loop(BASE, 'linkV')
2013 os.symlink(join('linkW/../linkW'), join('linkW'))
2014 self._check_symlink_loop(BASE, 'linkW')
2015
2016 def test_glob(self):
2017 P = self.cls
2018 p = P(BASE)
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002019 given = set(p.glob("FILEa"))
2020 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2021 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002022 self.assertEqual(set(p.glob("FILEa*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002023
2024 def test_rglob(self):
2025 P = self.cls
2026 p = P(BASE, "dirC")
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002027 given = set(p.rglob("FILEd"))
2028 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2029 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002030 self.assertEqual(set(p.rglob("FILEd*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002031
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002032 def test_expanduser(self):
2033 P = self.cls
2034 support.import_module('pwd')
2035 import pwd
2036 pwdent = pwd.getpwuid(os.getuid())
2037 username = pwdent.pw_name
Serhiy Storchakaa3fd0b22016-05-03 21:17:03 +03002038 userhome = pwdent.pw_dir.rstrip('/') or '/'
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002039 # find arbitrary different user (if exists)
2040 for pwdent in pwd.getpwall():
2041 othername = pwdent.pw_name
2042 otherhome = pwdent.pw_dir.rstrip('/')
Victor Stinnere9694392015-01-10 09:00:20 +01002043 if othername != username and otherhome:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002044 break
2045
2046 p1 = P('~/Documents')
2047 p2 = P('~' + username + '/Documents')
2048 p3 = P('~' + othername + '/Documents')
2049 p4 = P('../~' + username + '/Documents')
2050 p5 = P('/~' + username + '/Documents')
2051 p6 = P('')
2052 p7 = P('~fakeuser/Documents')
2053
2054 with support.EnvironmentVarGuard() as env:
2055 env.pop('HOME', None)
2056
2057 self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
2058 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2059 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2060 self.assertEqual(p4.expanduser(), p4)
2061 self.assertEqual(p5.expanduser(), p5)
2062 self.assertEqual(p6.expanduser(), p6)
2063 self.assertRaises(RuntimeError, p7.expanduser)
2064
2065 env['HOME'] = '/tmp'
2066 self.assertEqual(p1.expanduser(), P('/tmp/Documents'))
2067 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2068 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2069 self.assertEqual(p4.expanduser(), p4)
2070 self.assertEqual(p5.expanduser(), p5)
2071 self.assertEqual(p6.expanduser(), p6)
2072 self.assertRaises(RuntimeError, p7.expanduser)
2073
Antoine Pitrou31119e42013-11-22 17:38:12 +01002074
2075@only_nt
2076class WindowsPathTest(_BasePathTest, unittest.TestCase):
2077 cls = pathlib.WindowsPath
2078
2079 def test_glob(self):
2080 P = self.cls
2081 p = P(BASE)
2082 self.assertEqual(set(p.glob("FILEa")), { P(BASE, "fileA") })
2083
2084 def test_rglob(self):
2085 P = self.cls
2086 p = P(BASE, "dirC")
2087 self.assertEqual(set(p.rglob("FILEd")), { P(BASE, "dirC/dirD/fileD") })
2088
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002089 def test_expanduser(self):
2090 P = self.cls
2091 with support.EnvironmentVarGuard() as env:
2092 env.pop('HOME', None)
2093 env.pop('USERPROFILE', None)
2094 env.pop('HOMEPATH', None)
2095 env.pop('HOMEDRIVE', None)
2096 env['USERNAME'] = 'alice'
2097
2098 # test that the path returns unchanged
2099 p1 = P('~/My Documents')
2100 p2 = P('~alice/My Documents')
2101 p3 = P('~bob/My Documents')
2102 p4 = P('/~/My Documents')
2103 p5 = P('d:~/My Documents')
2104 p6 = P('')
2105 self.assertRaises(RuntimeError, p1.expanduser)
2106 self.assertRaises(RuntimeError, p2.expanduser)
2107 self.assertRaises(RuntimeError, p3.expanduser)
2108 self.assertEqual(p4.expanduser(), p4)
2109 self.assertEqual(p5.expanduser(), p5)
2110 self.assertEqual(p6.expanduser(), p6)
2111
2112 def check():
2113 env.pop('USERNAME', None)
2114 self.assertEqual(p1.expanduser(),
2115 P('C:/Users/alice/My Documents'))
2116 self.assertRaises(KeyError, p2.expanduser)
2117 env['USERNAME'] = 'alice'
2118 self.assertEqual(p2.expanduser(),
2119 P('C:/Users/alice/My Documents'))
2120 self.assertEqual(p3.expanduser(),
2121 P('C:/Users/bob/My Documents'))
2122 self.assertEqual(p4.expanduser(), p4)
2123 self.assertEqual(p5.expanduser(), p5)
2124 self.assertEqual(p6.expanduser(), p6)
2125
2126 # test the first lookup key in the env vars
2127 env['HOME'] = 'C:\\Users\\alice'
2128 check()
2129
2130 # test that HOMEPATH is available instead
2131 env.pop('HOME', None)
2132 env['HOMEPATH'] = 'C:\\Users\\alice'
2133 check()
2134
2135 env['HOMEDRIVE'] = 'C:\\'
2136 env['HOMEPATH'] = 'Users\\alice'
2137 check()
2138
2139 env.pop('HOMEDRIVE', None)
2140 env.pop('HOMEPATH', None)
2141 env['USERPROFILE'] = 'C:\\Users\\alice'
2142 check()
2143
Antoine Pitrou31119e42013-11-22 17:38:12 +01002144
2145if __name__ == "__main__":
2146 unittest.main()