blob: f3b385fbf36721a6686848f9f228d7ceeebb1479 [file] [log] [blame]
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001import collections.abc
Antoine Pitrou31119e42013-11-22 17:38:12 +01002import io
3import os
Przemysław Spodymek216b7452018-08-27 23:33:45 +02004import sys
Antoine Pitrou31119e42013-11-22 17:38:12 +01005import errno
6import pathlib
7import pickle
Antoine Pitrou31119e42013-11-22 17:38:12 +01008import socket
9import stat
Antoine Pitrou31119e42013-11-22 17:38:12 +010010import tempfile
11import unittest
Armin Rigo22a594a2017-04-13 20:08:15 +020012from unittest import mock
Antoine Pitrou31119e42013-11-22 17:38:12 +010013
14from test import support
Serhiy Storchakab21d1552018-03-02 11:53:51 +020015from test.support import TESTFN, FakePath
Antoine Pitrou31119e42013-11-22 17:38:12 +010016
17try:
18 import grp, pwd
19except ImportError:
20 grp = pwd = None
21
22
23class _BaseFlavourTest(object):
24
25 def _check_parse_parts(self, arg, expected):
26 f = self.flavour.parse_parts
27 sep = self.flavour.sep
28 altsep = self.flavour.altsep
29 actual = f([x.replace('/', sep) for x in arg])
30 self.assertEqual(actual, expected)
31 if altsep:
32 actual = f([x.replace('/', altsep) for x in arg])
33 self.assertEqual(actual, expected)
34
35 def test_parse_parts_common(self):
36 check = self._check_parse_parts
37 sep = self.flavour.sep
Anthony Shaw83da9262019-01-07 07:31:29 +110038 # Unanchored parts.
Antoine Pitrou31119e42013-11-22 17:38:12 +010039 check([], ('', '', []))
40 check(['a'], ('', '', ['a']))
41 check(['a/'], ('', '', ['a']))
42 check(['a', 'b'], ('', '', ['a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110043 # Expansion.
Antoine Pitrou31119e42013-11-22 17:38:12 +010044 check(['a/b'], ('', '', ['a', 'b']))
45 check(['a/b/'], ('', '', ['a', 'b']))
46 check(['a', 'b/c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +110047 # Collapsing and stripping excess slashes.
Antoine Pitrou31119e42013-11-22 17:38:12 +010048 check(['a', 'b//c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
49 check(['a', 'b/c/', 'd'], ('', '', ['a', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +110050 # Eliminating standalone dots.
Antoine Pitrou31119e42013-11-22 17:38:12 +010051 check(['.'], ('', '', []))
52 check(['.', '.', 'b'], ('', '', ['b']))
53 check(['a', '.', 'b'], ('', '', ['a', 'b']))
54 check(['a', '.', '.'], ('', '', ['a']))
Anthony Shaw83da9262019-01-07 07:31:29 +110055 # The first part is anchored.
Antoine Pitrou31119e42013-11-22 17:38:12 +010056 check(['/a/b'], ('', sep, [sep, 'a', 'b']))
57 check(['/a', 'b'], ('', sep, [sep, 'a', 'b']))
58 check(['/a/', 'b'], ('', sep, [sep, 'a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110059 # Ignoring parts before an anchored part.
Antoine Pitrou31119e42013-11-22 17:38:12 +010060 check(['a', '/b', 'c'], ('', sep, [sep, 'b', 'c']))
61 check(['a', '/b', '/c'], ('', sep, [sep, 'c']))
62
63
64class PosixFlavourTest(_BaseFlavourTest, unittest.TestCase):
65 flavour = pathlib._posix_flavour
66
67 def test_parse_parts(self):
68 check = self._check_parse_parts
69 # Collapsing of excess leading slashes, except for the double-slash
70 # special case.
71 check(['//a', 'b'], ('', '//', ['//', 'a', 'b']))
72 check(['///a', 'b'], ('', '/', ['/', 'a', 'b']))
73 check(['////a', 'b'], ('', '/', ['/', 'a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110074 # Paths which look like NT paths aren't treated specially.
Antoine Pitrou31119e42013-11-22 17:38:12 +010075 check(['c:a'], ('', '', ['c:a']))
76 check(['c:\\a'], ('', '', ['c:\\a']))
77 check(['\\a'], ('', '', ['\\a']))
78
79 def test_splitroot(self):
80 f = self.flavour.splitroot
81 self.assertEqual(f(''), ('', '', ''))
82 self.assertEqual(f('a'), ('', '', 'a'))
83 self.assertEqual(f('a/b'), ('', '', 'a/b'))
84 self.assertEqual(f('a/b/'), ('', '', 'a/b/'))
85 self.assertEqual(f('/a'), ('', '/', 'a'))
86 self.assertEqual(f('/a/b'), ('', '/', 'a/b'))
87 self.assertEqual(f('/a/b/'), ('', '/', 'a/b/'))
88 # The root is collapsed when there are redundant slashes
89 # except when there are exactly two leading slashes, which
90 # is a special case in POSIX.
91 self.assertEqual(f('//a'), ('', '//', 'a'))
92 self.assertEqual(f('///a'), ('', '/', 'a'))
93 self.assertEqual(f('///a/b'), ('', '/', 'a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +110094 # Paths which look like NT paths aren't treated specially.
Antoine Pitrou31119e42013-11-22 17:38:12 +010095 self.assertEqual(f('c:/a/b'), ('', '', 'c:/a/b'))
96 self.assertEqual(f('\\/a/b'), ('', '', '\\/a/b'))
97 self.assertEqual(f('\\a\\b'), ('', '', '\\a\\b'))
98
99
100class NTFlavourTest(_BaseFlavourTest, unittest.TestCase):
101 flavour = pathlib._windows_flavour
102
103 def test_parse_parts(self):
104 check = self._check_parse_parts
Anthony Shaw83da9262019-01-07 07:31:29 +1100105 # First part is anchored.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100106 check(['c:'], ('c:', '', ['c:']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100107 check(['c:/'], ('c:', '\\', ['c:\\']))
108 check(['/'], ('', '\\', ['\\']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100109 check(['c:a'], ('c:', '', ['c:', 'a']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100110 check(['c:/a'], ('c:', '\\', ['c:\\', 'a']))
111 check(['/a'], ('', '\\', ['\\', 'a']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100112 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100113 check(['//a/b'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
114 check(['//a/b/'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
115 check(['//a/b/c'], ('\\\\a\\b', '\\', ['\\\\a\\b\\', 'c']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100116 # Second part is anchored, so that the first part is ignored.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100117 check(['a', 'Z:b', 'c'], ('Z:', '', ['Z:', 'b', 'c']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100118 check(['a', 'Z:/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100119 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100120 check(['a', '//b/c', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100121 # Collapsing and stripping excess slashes.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100122 check(['a', 'Z://b//c/', 'd/'], ('Z:', '\\', ['Z:\\', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100123 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100124 check(['a', '//b/c//', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100125 # Extended paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100126 check(['//?/c:/'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\']))
127 check(['//?/c:/a'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'a']))
128 check(['//?/c:/a', '/b'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100129 # Extended UNC paths (format is "\\?\UNC\server\share").
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100130 check(['//?/UNC/b/c'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\']))
131 check(['//?/UNC/b/c/d'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100132 # Second part has a root but not drive.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100133 check(['a', '/b', 'c'], ('', '\\', ['\\', 'b', 'c']))
134 check(['Z:/a', '/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
135 check(['//?/Z:/a', '/b', 'c'], ('\\\\?\\Z:', '\\', ['\\\\?\\Z:\\', 'b', 'c']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100136
137 def test_splitroot(self):
138 f = self.flavour.splitroot
139 self.assertEqual(f(''), ('', '', ''))
140 self.assertEqual(f('a'), ('', '', 'a'))
141 self.assertEqual(f('a\\b'), ('', '', 'a\\b'))
142 self.assertEqual(f('\\a'), ('', '\\', 'a'))
143 self.assertEqual(f('\\a\\b'), ('', '\\', 'a\\b'))
144 self.assertEqual(f('c:a\\b'), ('c:', '', 'a\\b'))
145 self.assertEqual(f('c:\\a\\b'), ('c:', '\\', 'a\\b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100146 # Redundant slashes in the root are collapsed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100147 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
148 self.assertEqual(f('\\\\\\a/b'), ('', '\\', 'a/b'))
149 self.assertEqual(f('c:\\\\a'), ('c:', '\\', 'a'))
150 self.assertEqual(f('c:\\\\\\a/b'), ('c:', '\\', 'a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100151 # Valid UNC paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100152 self.assertEqual(f('\\\\a\\b'), ('\\\\a\\b', '\\', ''))
153 self.assertEqual(f('\\\\a\\b\\'), ('\\\\a\\b', '\\', ''))
154 self.assertEqual(f('\\\\a\\b\\c\\d'), ('\\\\a\\b', '\\', 'c\\d'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100155 # These are non-UNC paths (according to ntpath.py and test_ntpath).
Antoine Pitrou31119e42013-11-22 17:38:12 +0100156 # However, command.com says such paths are invalid, so it's
Anthony Shaw83da9262019-01-07 07:31:29 +1100157 # difficult to know what the right semantics are.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100158 self.assertEqual(f('\\\\\\a\\b'), ('', '\\', 'a\\b'))
159 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
160
161
162#
Anthony Shaw83da9262019-01-07 07:31:29 +1100163# Tests for the pure classes.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100164#
165
166class _BasePurePathTest(object):
167
Anthony Shaw83da9262019-01-07 07:31:29 +1100168 # Keys are canonical paths, values are list of tuples of arguments
169 # supposed to produce equal paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100170 equivalences = {
171 'a/b': [
172 ('a', 'b'), ('a/', 'b'), ('a', 'b/'), ('a/', 'b/'),
173 ('a/b/',), ('a//b',), ('a//b//',),
Anthony Shaw83da9262019-01-07 07:31:29 +1100174 # Empty components get removed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100175 ('', 'a', 'b'), ('a', '', 'b'), ('a', 'b', ''),
176 ],
177 '/b/c/d': [
178 ('a', '/b/c', 'd'), ('a', '///b//c', 'd/'),
179 ('/a', '/b/c', 'd'),
Anthony Shaw83da9262019-01-07 07:31:29 +1100180 # Empty components get removed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100181 ('/', 'b', '', 'c/d'), ('/', '', 'b/c/d'), ('', '/b/c/d'),
182 ],
183 }
184
185 def setUp(self):
186 p = self.cls('a')
187 self.flavour = p._flavour
188 self.sep = self.flavour.sep
189 self.altsep = self.flavour.altsep
190
191 def test_constructor_common(self):
192 P = self.cls
193 p = P('a')
194 self.assertIsInstance(p, P)
195 P('a', 'b', 'c')
196 P('/a', 'b', 'c')
197 P('a/b/c')
198 P('/a/b/c')
Serhiy Storchakab21d1552018-03-02 11:53:51 +0200199 P(FakePath("a/b/c"))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100200 self.assertEqual(P(P('a')), P('a'))
201 self.assertEqual(P(P('a'), 'b'), P('a/b'))
202 self.assertEqual(P(P('a'), P('b')), P('a/b'))
Serhiy Storchakab21d1552018-03-02 11:53:51 +0200203 self.assertEqual(P(P('a'), P('b'), P('c')), P(FakePath("a/b/c")))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100204
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200205 def _check_str_subclass(self, *args):
206 # Issue #21127: it should be possible to construct a PurePath object
Serhiy Storchaka6a7b3a72016-04-17 08:32:47 +0300207 # from a str subclass instance, and it then gets converted to
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200208 # a pure str object.
209 class StrSubclass(str):
210 pass
211 P = self.cls
212 p = P(*(StrSubclass(x) for x in args))
213 self.assertEqual(p, P(*args))
214 for part in p.parts:
215 self.assertIs(type(part), str)
216
217 def test_str_subclass_common(self):
218 self._check_str_subclass('')
219 self._check_str_subclass('.')
220 self._check_str_subclass('a')
221 self._check_str_subclass('a/b.txt')
222 self._check_str_subclass('/a/b.txt')
223
Antoine Pitrou31119e42013-11-22 17:38:12 +0100224 def test_join_common(self):
225 P = self.cls
226 p = P('a/b')
227 pp = p.joinpath('c')
228 self.assertEqual(pp, P('a/b/c'))
229 self.assertIs(type(pp), type(p))
230 pp = p.joinpath('c', 'd')
231 self.assertEqual(pp, P('a/b/c/d'))
232 pp = p.joinpath(P('c'))
233 self.assertEqual(pp, P('a/b/c'))
234 pp = p.joinpath('/c')
235 self.assertEqual(pp, P('/c'))
236
237 def test_div_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100238 # Basically the same as joinpath().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100239 P = self.cls
240 p = P('a/b')
241 pp = p / 'c'
242 self.assertEqual(pp, P('a/b/c'))
243 self.assertIs(type(pp), type(p))
244 pp = p / 'c/d'
245 self.assertEqual(pp, P('a/b/c/d'))
246 pp = p / 'c' / 'd'
247 self.assertEqual(pp, P('a/b/c/d'))
248 pp = 'c' / p / 'd'
249 self.assertEqual(pp, P('c/a/b/d'))
250 pp = p / P('c')
251 self.assertEqual(pp, P('a/b/c'))
252 pp = p/ '/c'
253 self.assertEqual(pp, P('/c'))
254
255 def _check_str(self, expected, args):
256 p = self.cls(*args)
257 self.assertEqual(str(p), expected.replace('/', self.sep))
258
259 def test_str_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100260 # Canonicalized paths roundtrip.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100261 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
262 self._check_str(pathstr, (pathstr,))
Anthony Shaw83da9262019-01-07 07:31:29 +1100263 # Special case for the empty path.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100264 self._check_str('.', ('',))
Anthony Shaw83da9262019-01-07 07:31:29 +1100265 # Other tests for str() are in test_equivalences().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100266
267 def test_as_posix_common(self):
268 P = self.cls
269 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
270 self.assertEqual(P(pathstr).as_posix(), pathstr)
Anthony Shaw83da9262019-01-07 07:31:29 +1100271 # Other tests for as_posix() are in test_equivalences().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100272
273 def test_as_bytes_common(self):
274 sep = os.fsencode(self.sep)
275 P = self.cls
276 self.assertEqual(bytes(P('a/b')), b'a' + sep + b'b')
277
278 def test_as_uri_common(self):
279 P = self.cls
280 with self.assertRaises(ValueError):
281 P('a').as_uri()
282 with self.assertRaises(ValueError):
283 P().as_uri()
284
285 def test_repr_common(self):
286 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
287 p = self.cls(pathstr)
288 clsname = p.__class__.__name__
289 r = repr(p)
Anthony Shaw83da9262019-01-07 07:31:29 +1100290 # The repr() is in the form ClassName("forward-slashes path").
Antoine Pitrou31119e42013-11-22 17:38:12 +0100291 self.assertTrue(r.startswith(clsname + '('), r)
292 self.assertTrue(r.endswith(')'), r)
293 inner = r[len(clsname) + 1 : -1]
294 self.assertEqual(eval(inner), p.as_posix())
Anthony Shaw83da9262019-01-07 07:31:29 +1100295 # The repr() roundtrips.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100296 q = eval(r, pathlib.__dict__)
297 self.assertIs(q.__class__, p.__class__)
298 self.assertEqual(q, p)
299 self.assertEqual(repr(q), r)
300
301 def test_eq_common(self):
302 P = self.cls
303 self.assertEqual(P('a/b'), P('a/b'))
304 self.assertEqual(P('a/b'), P('a', 'b'))
305 self.assertNotEqual(P('a/b'), P('a'))
306 self.assertNotEqual(P('a/b'), P('/a/b'))
307 self.assertNotEqual(P('a/b'), P())
308 self.assertNotEqual(P('/a/b'), P('/'))
309 self.assertNotEqual(P(), P('/'))
310 self.assertNotEqual(P(), "")
311 self.assertNotEqual(P(), {})
312 self.assertNotEqual(P(), int)
313
314 def test_match_common(self):
315 P = self.cls
316 self.assertRaises(ValueError, P('a').match, '')
317 self.assertRaises(ValueError, P('a').match, '.')
Anthony Shaw83da9262019-01-07 07:31:29 +1100318 # Simple relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100319 self.assertTrue(P('b.py').match('b.py'))
320 self.assertTrue(P('a/b.py').match('b.py'))
321 self.assertTrue(P('/a/b.py').match('b.py'))
322 self.assertFalse(P('a.py').match('b.py'))
323 self.assertFalse(P('b/py').match('b.py'))
324 self.assertFalse(P('/a.py').match('b.py'))
325 self.assertFalse(P('b.py/c').match('b.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100326 # Wilcard relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100327 self.assertTrue(P('b.py').match('*.py'))
328 self.assertTrue(P('a/b.py').match('*.py'))
329 self.assertTrue(P('/a/b.py').match('*.py'))
330 self.assertFalse(P('b.pyc').match('*.py'))
331 self.assertFalse(P('b./py').match('*.py'))
332 self.assertFalse(P('b.py/c').match('*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100333 # Multi-part relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100334 self.assertTrue(P('ab/c.py').match('a*/*.py'))
335 self.assertTrue(P('/d/ab/c.py').match('a*/*.py'))
336 self.assertFalse(P('a.py').match('a*/*.py'))
337 self.assertFalse(P('/dab/c.py').match('a*/*.py'))
338 self.assertFalse(P('ab/c.py/d').match('a*/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100339 # Absolute pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100340 self.assertTrue(P('/b.py').match('/*.py'))
341 self.assertFalse(P('b.py').match('/*.py'))
342 self.assertFalse(P('a/b.py').match('/*.py'))
343 self.assertFalse(P('/a/b.py').match('/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100344 # Multi-part absolute pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100345 self.assertTrue(P('/a/b.py').match('/a/*.py'))
346 self.assertFalse(P('/ab.py').match('/a/*.py'))
347 self.assertFalse(P('/a/b/c.py').match('/a/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100348 # Multi-part glob-style pattern.
349 self.assertFalse(P('/a/b/c.py').match('/**/*.py'))
350 self.assertTrue(P('/a/b/c.py').match('/a/**/*.py'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100351
352 def test_ordering_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100353 # Ordering is tuple-alike.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100354 def assertLess(a, b):
355 self.assertLess(a, b)
356 self.assertGreater(b, a)
357 P = self.cls
358 a = P('a')
359 b = P('a/b')
360 c = P('abc')
361 d = P('b')
362 assertLess(a, b)
363 assertLess(a, c)
364 assertLess(a, d)
365 assertLess(b, c)
366 assertLess(c, d)
367 P = self.cls
368 a = P('/a')
369 b = P('/a/b')
370 c = P('/abc')
371 d = P('/b')
372 assertLess(a, b)
373 assertLess(a, c)
374 assertLess(a, d)
375 assertLess(b, c)
376 assertLess(c, d)
377 with self.assertRaises(TypeError):
378 P() < {}
379
380 def test_parts_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100381 # `parts` returns a tuple.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100382 sep = self.sep
383 P = self.cls
384 p = P('a/b')
385 parts = p.parts
386 self.assertEqual(parts, ('a', 'b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100387 # The object gets reused.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100388 self.assertIs(parts, p.parts)
Anthony Shaw83da9262019-01-07 07:31:29 +1100389 # When the path is absolute, the anchor is a separate part.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100390 p = P('/a/b')
391 parts = p.parts
392 self.assertEqual(parts, (sep, 'a', 'b'))
393
Brett Cannon568be632016-06-10 12:20:49 -0700394 def test_fspath_common(self):
395 P = self.cls
396 p = P('a/b')
397 self._check_str(p.__fspath__(), ('a/b',))
398 self._check_str(os.fspath(p), ('a/b',))
399
Antoine Pitrou31119e42013-11-22 17:38:12 +0100400 def test_equivalences(self):
401 for k, tuples in self.equivalences.items():
402 canon = k.replace('/', self.sep)
403 posix = k.replace(self.sep, '/')
404 if canon != posix:
405 tuples = tuples + [
406 tuple(part.replace('/', self.sep) for part in t)
407 for t in tuples
408 ]
409 tuples.append((posix, ))
410 pcanon = self.cls(canon)
411 for t in tuples:
412 p = self.cls(*t)
413 self.assertEqual(p, pcanon, "failed with args {}".format(t))
414 self.assertEqual(hash(p), hash(pcanon))
415 self.assertEqual(str(p), canon)
416 self.assertEqual(p.as_posix(), posix)
417
418 def test_parent_common(self):
419 # Relative
420 P = self.cls
421 p = P('a/b/c')
422 self.assertEqual(p.parent, P('a/b'))
423 self.assertEqual(p.parent.parent, P('a'))
424 self.assertEqual(p.parent.parent.parent, P())
425 self.assertEqual(p.parent.parent.parent.parent, P())
426 # Anchored
427 p = P('/a/b/c')
428 self.assertEqual(p.parent, P('/a/b'))
429 self.assertEqual(p.parent.parent, P('/a'))
430 self.assertEqual(p.parent.parent.parent, P('/'))
431 self.assertEqual(p.parent.parent.parent.parent, P('/'))
432
433 def test_parents_common(self):
434 # Relative
435 P = self.cls
436 p = P('a/b/c')
437 par = p.parents
438 self.assertEqual(len(par), 3)
439 self.assertEqual(par[0], P('a/b'))
440 self.assertEqual(par[1], P('a'))
441 self.assertEqual(par[2], P('.'))
442 self.assertEqual(list(par), [P('a/b'), P('a'), P('.')])
443 with self.assertRaises(IndexError):
444 par[-1]
445 with self.assertRaises(IndexError):
446 par[3]
447 with self.assertRaises(TypeError):
448 par[0] = p
449 # Anchored
450 p = P('/a/b/c')
451 par = p.parents
452 self.assertEqual(len(par), 3)
453 self.assertEqual(par[0], P('/a/b'))
454 self.assertEqual(par[1], P('/a'))
455 self.assertEqual(par[2], P('/'))
456 self.assertEqual(list(par), [P('/a/b'), P('/a'), P('/')])
457 with self.assertRaises(IndexError):
458 par[3]
459
460 def test_drive_common(self):
461 P = self.cls
462 self.assertEqual(P('a/b').drive, '')
463 self.assertEqual(P('/a/b').drive, '')
464 self.assertEqual(P('').drive, '')
465
466 def test_root_common(self):
467 P = self.cls
468 sep = self.sep
469 self.assertEqual(P('').root, '')
470 self.assertEqual(P('a/b').root, '')
471 self.assertEqual(P('/').root, sep)
472 self.assertEqual(P('/a/b').root, sep)
473
474 def test_anchor_common(self):
475 P = self.cls
476 sep = self.sep
477 self.assertEqual(P('').anchor, '')
478 self.assertEqual(P('a/b').anchor, '')
479 self.assertEqual(P('/').anchor, sep)
480 self.assertEqual(P('/a/b').anchor, sep)
481
482 def test_name_common(self):
483 P = self.cls
484 self.assertEqual(P('').name, '')
485 self.assertEqual(P('.').name, '')
486 self.assertEqual(P('/').name, '')
487 self.assertEqual(P('a/b').name, 'b')
488 self.assertEqual(P('/a/b').name, 'b')
489 self.assertEqual(P('/a/b/.').name, 'b')
490 self.assertEqual(P('a/b.py').name, 'b.py')
491 self.assertEqual(P('/a/b.py').name, 'b.py')
492
493 def test_suffix_common(self):
494 P = self.cls
495 self.assertEqual(P('').suffix, '')
496 self.assertEqual(P('.').suffix, '')
497 self.assertEqual(P('..').suffix, '')
498 self.assertEqual(P('/').suffix, '')
499 self.assertEqual(P('a/b').suffix, '')
500 self.assertEqual(P('/a/b').suffix, '')
501 self.assertEqual(P('/a/b/.').suffix, '')
502 self.assertEqual(P('a/b.py').suffix, '.py')
503 self.assertEqual(P('/a/b.py').suffix, '.py')
504 self.assertEqual(P('a/.hgrc').suffix, '')
505 self.assertEqual(P('/a/.hgrc').suffix, '')
506 self.assertEqual(P('a/.hg.rc').suffix, '.rc')
507 self.assertEqual(P('/a/.hg.rc').suffix, '.rc')
508 self.assertEqual(P('a/b.tar.gz').suffix, '.gz')
509 self.assertEqual(P('/a/b.tar.gz').suffix, '.gz')
510 self.assertEqual(P('a/Some name. Ending with a dot.').suffix, '')
511 self.assertEqual(P('/a/Some name. Ending with a dot.').suffix, '')
512
513 def test_suffixes_common(self):
514 P = self.cls
515 self.assertEqual(P('').suffixes, [])
516 self.assertEqual(P('.').suffixes, [])
517 self.assertEqual(P('/').suffixes, [])
518 self.assertEqual(P('a/b').suffixes, [])
519 self.assertEqual(P('/a/b').suffixes, [])
520 self.assertEqual(P('/a/b/.').suffixes, [])
521 self.assertEqual(P('a/b.py').suffixes, ['.py'])
522 self.assertEqual(P('/a/b.py').suffixes, ['.py'])
523 self.assertEqual(P('a/.hgrc').suffixes, [])
524 self.assertEqual(P('/a/.hgrc').suffixes, [])
525 self.assertEqual(P('a/.hg.rc').suffixes, ['.rc'])
526 self.assertEqual(P('/a/.hg.rc').suffixes, ['.rc'])
527 self.assertEqual(P('a/b.tar.gz').suffixes, ['.tar', '.gz'])
528 self.assertEqual(P('/a/b.tar.gz').suffixes, ['.tar', '.gz'])
529 self.assertEqual(P('a/Some name. Ending with a dot.').suffixes, [])
530 self.assertEqual(P('/a/Some name. Ending with a dot.').suffixes, [])
531
532 def test_stem_common(self):
533 P = self.cls
534 self.assertEqual(P('').stem, '')
535 self.assertEqual(P('.').stem, '')
536 self.assertEqual(P('..').stem, '..')
537 self.assertEqual(P('/').stem, '')
538 self.assertEqual(P('a/b').stem, 'b')
539 self.assertEqual(P('a/b.py').stem, 'b')
540 self.assertEqual(P('a/.hgrc').stem, '.hgrc')
541 self.assertEqual(P('a/.hg.rc').stem, '.hg')
542 self.assertEqual(P('a/b.tar.gz').stem, 'b.tar')
543 self.assertEqual(P('a/Some name. Ending with a dot.').stem,
544 'Some name. Ending with a dot.')
545
546 def test_with_name_common(self):
547 P = self.cls
548 self.assertEqual(P('a/b').with_name('d.xml'), P('a/d.xml'))
549 self.assertEqual(P('/a/b').with_name('d.xml'), P('/a/d.xml'))
550 self.assertEqual(P('a/b.py').with_name('d.xml'), P('a/d.xml'))
551 self.assertEqual(P('/a/b.py').with_name('d.xml'), P('/a/d.xml'))
552 self.assertEqual(P('a/Dot ending.').with_name('d.xml'), P('a/d.xml'))
553 self.assertEqual(P('/a/Dot ending.').with_name('d.xml'), P('/a/d.xml'))
554 self.assertRaises(ValueError, P('').with_name, 'd.xml')
555 self.assertRaises(ValueError, P('.').with_name, 'd.xml')
556 self.assertRaises(ValueError, P('/').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400557 self.assertRaises(ValueError, P('a/b').with_name, '')
558 self.assertRaises(ValueError, P('a/b').with_name, '/c')
559 self.assertRaises(ValueError, P('a/b').with_name, 'c/')
560 self.assertRaises(ValueError, P('a/b').with_name, 'c/d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100561
562 def test_with_suffix_common(self):
563 P = self.cls
564 self.assertEqual(P('a/b').with_suffix('.gz'), P('a/b.gz'))
565 self.assertEqual(P('/a/b').with_suffix('.gz'), P('/a/b.gz'))
566 self.assertEqual(P('a/b.py').with_suffix('.gz'), P('a/b.gz'))
567 self.assertEqual(P('/a/b.py').with_suffix('.gz'), P('/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100568 # Stripping suffix.
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400569 self.assertEqual(P('a/b.py').with_suffix(''), P('a/b'))
570 self.assertEqual(P('/a/b').with_suffix(''), P('/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100571 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100572 self.assertRaises(ValueError, P('').with_suffix, '.gz')
573 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
574 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +1100575 # Invalid suffix.
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100576 self.assertRaises(ValueError, P('a/b').with_suffix, 'gz')
577 self.assertRaises(ValueError, P('a/b').with_suffix, '/')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400578 self.assertRaises(ValueError, P('a/b').with_suffix, '.')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100579 self.assertRaises(ValueError, P('a/b').with_suffix, '/.gz')
580 self.assertRaises(ValueError, P('a/b').with_suffix, 'c/d')
581 self.assertRaises(ValueError, P('a/b').with_suffix, '.c/.d')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400582 self.assertRaises(ValueError, P('a/b').with_suffix, './.d')
583 self.assertRaises(ValueError, P('a/b').with_suffix, '.d/.')
Berker Peksag423d05f2018-08-11 08:45:06 +0300584 self.assertRaises(ValueError, P('a/b').with_suffix,
585 (self.flavour.sep, 'd'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100586
587 def test_relative_to_common(self):
588 P = self.cls
589 p = P('a/b')
590 self.assertRaises(TypeError, p.relative_to)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100591 self.assertRaises(TypeError, p.relative_to, b'a')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100592 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())
Anthony Shaw83da9262019-01-07 07:31:29 +1100599 # With several args.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100600 self.assertEqual(p.relative_to('a', 'b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100601 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100602 self.assertRaises(ValueError, p.relative_to, P('c'))
603 self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
604 self.assertRaises(ValueError, p.relative_to, P('a/c'))
605 self.assertRaises(ValueError, p.relative_to, P('/a'))
606 p = P('/a/b')
607 self.assertEqual(p.relative_to(P('/')), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100608 self.assertEqual(p.relative_to('/'), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100609 self.assertEqual(p.relative_to(P('/a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100610 self.assertEqual(p.relative_to('/a'), P('b'))
611 self.assertEqual(p.relative_to('/a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100612 self.assertEqual(p.relative_to(P('/a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100613 self.assertEqual(p.relative_to('/a/b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100614 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100615 self.assertRaises(ValueError, p.relative_to, P('/c'))
616 self.assertRaises(ValueError, p.relative_to, P('/a/b/c'))
617 self.assertRaises(ValueError, p.relative_to, P('/a/c'))
618 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100619 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100620 self.assertRaises(ValueError, p.relative_to, P('a'))
621
Hai Shi82642a02019-08-13 14:54:02 -0500622 def test_is_relative_to_common(self):
623 P = self.cls
624 p = P('a/b')
625 self.assertRaises(TypeError, p.is_relative_to)
626 self.assertRaises(TypeError, p.is_relative_to, b'a')
627 self.assertTrue(p.is_relative_to(P()))
628 self.assertTrue(p.is_relative_to(''))
629 self.assertTrue(p.is_relative_to(P('a')))
630 self.assertTrue(p.is_relative_to('a/'))
631 self.assertTrue(p.is_relative_to(P('a/b')))
632 self.assertTrue(p.is_relative_to('a/b'))
633 # With several args.
634 self.assertTrue(p.is_relative_to('a', 'b'))
635 # Unrelated paths.
636 self.assertFalse(p.is_relative_to(P('c')))
637 self.assertFalse(p.is_relative_to(P('a/b/c')))
638 self.assertFalse(p.is_relative_to(P('a/c')))
639 self.assertFalse(p.is_relative_to(P('/a')))
640 p = P('/a/b')
641 self.assertTrue(p.is_relative_to(P('/')))
642 self.assertTrue(p.is_relative_to('/'))
643 self.assertTrue(p.is_relative_to(P('/a')))
644 self.assertTrue(p.is_relative_to('/a'))
645 self.assertTrue(p.is_relative_to('/a/'))
646 self.assertTrue(p.is_relative_to(P('/a/b')))
647 self.assertTrue(p.is_relative_to('/a/b'))
648 # Unrelated paths.
649 self.assertFalse(p.is_relative_to(P('/c')))
650 self.assertFalse(p.is_relative_to(P('/a/b/c')))
651 self.assertFalse(p.is_relative_to(P('/a/c')))
652 self.assertFalse(p.is_relative_to(P()))
653 self.assertFalse(p.is_relative_to(''))
654 self.assertFalse(p.is_relative_to(P('a')))
655
Antoine Pitrou31119e42013-11-22 17:38:12 +0100656 def test_pickling_common(self):
657 P = self.cls
658 p = P('/a/b')
659 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
660 dumped = pickle.dumps(p, proto)
661 pp = pickle.loads(dumped)
662 self.assertIs(pp.__class__, p.__class__)
663 self.assertEqual(pp, p)
664 self.assertEqual(hash(pp), hash(p))
665 self.assertEqual(str(pp), str(p))
666
667
668class PurePosixPathTest(_BasePurePathTest, unittest.TestCase):
669 cls = pathlib.PurePosixPath
670
671 def test_root(self):
672 P = self.cls
673 self.assertEqual(P('/a/b').root, '/')
674 self.assertEqual(P('///a/b').root, '/')
Anthony Shaw83da9262019-01-07 07:31:29 +1100675 # POSIX special case for two leading slashes.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100676 self.assertEqual(P('//a/b').root, '//')
677
678 def test_eq(self):
679 P = self.cls
680 self.assertNotEqual(P('a/b'), P('A/b'))
681 self.assertEqual(P('/a'), P('///a'))
682 self.assertNotEqual(P('/a'), P('//a'))
683
684 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100685 P = self.cls
686 self.assertEqual(P('/').as_uri(), 'file:///')
687 self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')
688 self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')
Antoine Pitrou29eac422013-11-22 17:57:03 +0100689
690 def test_as_uri_non_ascii(self):
691 from urllib.parse import quote_from_bytes
692 P = self.cls
693 try:
694 os.fsencode('\xe9')
695 except UnicodeEncodeError:
696 self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")
Antoine Pitrou31119e42013-11-22 17:38:12 +0100697 self.assertEqual(P('/a/b\xe9').as_uri(),
698 'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))
699
700 def test_match(self):
701 P = self.cls
702 self.assertFalse(P('A.py').match('a.PY'))
703
704 def test_is_absolute(self):
705 P = self.cls
706 self.assertFalse(P().is_absolute())
707 self.assertFalse(P('a').is_absolute())
708 self.assertFalse(P('a/b/').is_absolute())
709 self.assertTrue(P('/').is_absolute())
710 self.assertTrue(P('/a').is_absolute())
711 self.assertTrue(P('/a/b/').is_absolute())
712 self.assertTrue(P('//a').is_absolute())
713 self.assertTrue(P('//a/b').is_absolute())
714
715 def test_is_reserved(self):
716 P = self.cls
717 self.assertIs(False, P('').is_reserved())
718 self.assertIs(False, P('/').is_reserved())
719 self.assertIs(False, P('/foo/bar').is_reserved())
720 self.assertIs(False, P('/dev/con/PRN/NUL').is_reserved())
721
722 def test_join(self):
723 P = self.cls
724 p = P('//a')
725 pp = p.joinpath('b')
726 self.assertEqual(pp, P('//a/b'))
727 pp = P('/a').joinpath('//c')
728 self.assertEqual(pp, P('//c'))
729 pp = P('//a').joinpath('/c')
730 self.assertEqual(pp, P('/c'))
731
732 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100733 # Basically the same as joinpath().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100734 P = self.cls
735 p = P('//a')
736 pp = p / 'b'
737 self.assertEqual(pp, P('//a/b'))
738 pp = P('/a') / '//c'
739 self.assertEqual(pp, P('//c'))
740 pp = P('//a') / '/c'
741 self.assertEqual(pp, P('/c'))
742
743
744class PureWindowsPathTest(_BasePurePathTest, unittest.TestCase):
745 cls = pathlib.PureWindowsPath
746
747 equivalences = _BasePurePathTest.equivalences.copy()
748 equivalences.update({
749 'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('/', 'c:', 'a') ],
750 'c:/a': [
751 ('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),
752 ('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),
753 ],
754 '//a/b/': [ ('//a/b',) ],
755 '//a/b/c': [
756 ('//a/b', 'c'), ('//a/b/', 'c'),
757 ],
758 })
759
760 def test_str(self):
761 p = self.cls('a/b/c')
762 self.assertEqual(str(p), 'a\\b\\c')
763 p = self.cls('c:/a/b/c')
764 self.assertEqual(str(p), 'c:\\a\\b\\c')
765 p = self.cls('//a/b')
766 self.assertEqual(str(p), '\\\\a\\b\\')
767 p = self.cls('//a/b/c')
768 self.assertEqual(str(p), '\\\\a\\b\\c')
769 p = self.cls('//a/b/c/d')
770 self.assertEqual(str(p), '\\\\a\\b\\c\\d')
771
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200772 def test_str_subclass(self):
773 self._check_str_subclass('c:')
774 self._check_str_subclass('c:a')
775 self._check_str_subclass('c:a\\b.txt')
776 self._check_str_subclass('c:\\')
777 self._check_str_subclass('c:\\a')
778 self._check_str_subclass('c:\\a\\b.txt')
779 self._check_str_subclass('\\\\some\\share')
780 self._check_str_subclass('\\\\some\\share\\a')
781 self._check_str_subclass('\\\\some\\share\\a\\b.txt')
782
Antoine Pitrou31119e42013-11-22 17:38:12 +0100783 def test_eq(self):
784 P = self.cls
785 self.assertEqual(P('c:a/b'), P('c:a/b'))
786 self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))
787 self.assertNotEqual(P('c:a/b'), P('d:a/b'))
788 self.assertNotEqual(P('c:a/b'), P('c:/a/b'))
789 self.assertNotEqual(P('/a/b'), P('c:/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100790 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100791 self.assertEqual(P('a/B'), P('A/b'))
792 self.assertEqual(P('C:a/B'), P('c:A/b'))
793 self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))
794
795 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100796 P = self.cls
797 with self.assertRaises(ValueError):
798 P('/a/b').as_uri()
799 with self.assertRaises(ValueError):
800 P('c:a/b').as_uri()
801 self.assertEqual(P('c:/').as_uri(), 'file:///c:/')
802 self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')
803 self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')
804 self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')
805 self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')
806 self.assertEqual(P('//some/share/a/b.c').as_uri(),
807 'file://some/share/a/b.c')
808 self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),
809 'file://some/share/a/b%25%23c%C3%A9')
810
811 def test_match_common(self):
812 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +1100813 # Absolute patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100814 self.assertTrue(P('c:/b.py').match('/*.py'))
815 self.assertTrue(P('c:/b.py').match('c:*.py'))
816 self.assertTrue(P('c:/b.py').match('c:/*.py'))
817 self.assertFalse(P('d:/b.py').match('c:/*.py')) # wrong drive
818 self.assertFalse(P('b.py').match('/*.py'))
819 self.assertFalse(P('b.py').match('c:*.py'))
820 self.assertFalse(P('b.py').match('c:/*.py'))
821 self.assertFalse(P('c:b.py').match('/*.py'))
822 self.assertFalse(P('c:b.py').match('c:/*.py'))
823 self.assertFalse(P('/b.py').match('c:*.py'))
824 self.assertFalse(P('/b.py').match('c:/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100825 # UNC patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100826 self.assertTrue(P('//some/share/a.py').match('/*.py'))
827 self.assertTrue(P('//some/share/a.py').match('//some/share/*.py'))
828 self.assertFalse(P('//other/share/a.py').match('//some/share/*.py'))
829 self.assertFalse(P('//some/share/a/b.py').match('//some/share/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100830 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100831 self.assertTrue(P('B.py').match('b.PY'))
832 self.assertTrue(P('c:/a/B.Py').match('C:/A/*.pY'))
833 self.assertTrue(P('//Some/Share/B.Py').match('//somE/sharE/*.pY'))
834
835 def test_ordering_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100836 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100837 def assertOrderedEqual(a, b):
838 self.assertLessEqual(a, b)
839 self.assertGreaterEqual(b, a)
840 P = self.cls
841 p = P('c:A/b')
842 q = P('C:a/B')
843 assertOrderedEqual(p, q)
844 self.assertFalse(p < q)
845 self.assertFalse(p > q)
846 p = P('//some/Share/A/b')
847 q = P('//Some/SHARE/a/B')
848 assertOrderedEqual(p, q)
849 self.assertFalse(p < q)
850 self.assertFalse(p > q)
851
852 def test_parts(self):
853 P = self.cls
854 p = P('c:a/b')
855 parts = p.parts
856 self.assertEqual(parts, ('c:', 'a', 'b'))
857 p = P('c:/a/b')
858 parts = p.parts
859 self.assertEqual(parts, ('c:\\', 'a', 'b'))
860 p = P('//a/b/c/d')
861 parts = p.parts
862 self.assertEqual(parts, ('\\\\a\\b\\', 'c', 'd'))
863
864 def test_parent(self):
865 # Anchored
866 P = self.cls
867 p = P('z:a/b/c')
868 self.assertEqual(p.parent, P('z:a/b'))
869 self.assertEqual(p.parent.parent, P('z:a'))
870 self.assertEqual(p.parent.parent.parent, P('z:'))
871 self.assertEqual(p.parent.parent.parent.parent, P('z:'))
872 p = P('z:/a/b/c')
873 self.assertEqual(p.parent, P('z:/a/b'))
874 self.assertEqual(p.parent.parent, P('z:/a'))
875 self.assertEqual(p.parent.parent.parent, P('z:/'))
876 self.assertEqual(p.parent.parent.parent.parent, P('z:/'))
877 p = P('//a/b/c/d')
878 self.assertEqual(p.parent, P('//a/b/c'))
879 self.assertEqual(p.parent.parent, P('//a/b'))
880 self.assertEqual(p.parent.parent.parent, P('//a/b'))
881
882 def test_parents(self):
883 # Anchored
884 P = self.cls
885 p = P('z:a/b/')
886 par = p.parents
887 self.assertEqual(len(par), 2)
888 self.assertEqual(par[0], P('z:a'))
889 self.assertEqual(par[1], P('z:'))
890 self.assertEqual(list(par), [P('z:a'), P('z:')])
891 with self.assertRaises(IndexError):
892 par[2]
893 p = P('z:/a/b/')
894 par = p.parents
895 self.assertEqual(len(par), 2)
896 self.assertEqual(par[0], P('z:/a'))
897 self.assertEqual(par[1], P('z:/'))
898 self.assertEqual(list(par), [P('z:/a'), P('z:/')])
899 with self.assertRaises(IndexError):
900 par[2]
901 p = P('//a/b/c/d')
902 par = p.parents
903 self.assertEqual(len(par), 2)
904 self.assertEqual(par[0], P('//a/b/c'))
905 self.assertEqual(par[1], P('//a/b'))
906 self.assertEqual(list(par), [P('//a/b/c'), P('//a/b')])
907 with self.assertRaises(IndexError):
908 par[2]
909
910 def test_drive(self):
911 P = self.cls
912 self.assertEqual(P('c:').drive, 'c:')
913 self.assertEqual(P('c:a/b').drive, 'c:')
914 self.assertEqual(P('c:/').drive, 'c:')
915 self.assertEqual(P('c:/a/b/').drive, 'c:')
916 self.assertEqual(P('//a/b').drive, '\\\\a\\b')
917 self.assertEqual(P('//a/b/').drive, '\\\\a\\b')
918 self.assertEqual(P('//a/b/c/d').drive, '\\\\a\\b')
919
920 def test_root(self):
921 P = self.cls
922 self.assertEqual(P('c:').root, '')
923 self.assertEqual(P('c:a/b').root, '')
924 self.assertEqual(P('c:/').root, '\\')
925 self.assertEqual(P('c:/a/b/').root, '\\')
926 self.assertEqual(P('//a/b').root, '\\')
927 self.assertEqual(P('//a/b/').root, '\\')
928 self.assertEqual(P('//a/b/c/d').root, '\\')
929
930 def test_anchor(self):
931 P = self.cls
932 self.assertEqual(P('c:').anchor, 'c:')
933 self.assertEqual(P('c:a/b').anchor, 'c:')
934 self.assertEqual(P('c:/').anchor, 'c:\\')
935 self.assertEqual(P('c:/a/b/').anchor, 'c:\\')
936 self.assertEqual(P('//a/b').anchor, '\\\\a\\b\\')
937 self.assertEqual(P('//a/b/').anchor, '\\\\a\\b\\')
938 self.assertEqual(P('//a/b/c/d').anchor, '\\\\a\\b\\')
939
940 def test_name(self):
941 P = self.cls
942 self.assertEqual(P('c:').name, '')
943 self.assertEqual(P('c:/').name, '')
944 self.assertEqual(P('c:a/b').name, 'b')
945 self.assertEqual(P('c:/a/b').name, 'b')
946 self.assertEqual(P('c:a/b.py').name, 'b.py')
947 self.assertEqual(P('c:/a/b.py').name, 'b.py')
948 self.assertEqual(P('//My.py/Share.php').name, '')
949 self.assertEqual(P('//My.py/Share.php/a/b').name, 'b')
950
951 def test_suffix(self):
952 P = self.cls
953 self.assertEqual(P('c:').suffix, '')
954 self.assertEqual(P('c:/').suffix, '')
955 self.assertEqual(P('c:a/b').suffix, '')
956 self.assertEqual(P('c:/a/b').suffix, '')
957 self.assertEqual(P('c:a/b.py').suffix, '.py')
958 self.assertEqual(P('c:/a/b.py').suffix, '.py')
959 self.assertEqual(P('c:a/.hgrc').suffix, '')
960 self.assertEqual(P('c:/a/.hgrc').suffix, '')
961 self.assertEqual(P('c:a/.hg.rc').suffix, '.rc')
962 self.assertEqual(P('c:/a/.hg.rc').suffix, '.rc')
963 self.assertEqual(P('c:a/b.tar.gz').suffix, '.gz')
964 self.assertEqual(P('c:/a/b.tar.gz').suffix, '.gz')
965 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffix, '')
966 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffix, '')
967 self.assertEqual(P('//My.py/Share.php').suffix, '')
968 self.assertEqual(P('//My.py/Share.php/a/b').suffix, '')
969
970 def test_suffixes(self):
971 P = self.cls
972 self.assertEqual(P('c:').suffixes, [])
973 self.assertEqual(P('c:/').suffixes, [])
974 self.assertEqual(P('c:a/b').suffixes, [])
975 self.assertEqual(P('c:/a/b').suffixes, [])
976 self.assertEqual(P('c:a/b.py').suffixes, ['.py'])
977 self.assertEqual(P('c:/a/b.py').suffixes, ['.py'])
978 self.assertEqual(P('c:a/.hgrc').suffixes, [])
979 self.assertEqual(P('c:/a/.hgrc').suffixes, [])
980 self.assertEqual(P('c:a/.hg.rc').suffixes, ['.rc'])
981 self.assertEqual(P('c:/a/.hg.rc').suffixes, ['.rc'])
982 self.assertEqual(P('c:a/b.tar.gz').suffixes, ['.tar', '.gz'])
983 self.assertEqual(P('c:/a/b.tar.gz').suffixes, ['.tar', '.gz'])
984 self.assertEqual(P('//My.py/Share.php').suffixes, [])
985 self.assertEqual(P('//My.py/Share.php/a/b').suffixes, [])
986 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffixes, [])
987 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffixes, [])
988
989 def test_stem(self):
990 P = self.cls
991 self.assertEqual(P('c:').stem, '')
992 self.assertEqual(P('c:.').stem, '')
993 self.assertEqual(P('c:..').stem, '..')
994 self.assertEqual(P('c:/').stem, '')
995 self.assertEqual(P('c:a/b').stem, 'b')
996 self.assertEqual(P('c:a/b.py').stem, 'b')
997 self.assertEqual(P('c:a/.hgrc').stem, '.hgrc')
998 self.assertEqual(P('c:a/.hg.rc').stem, '.hg')
999 self.assertEqual(P('c:a/b.tar.gz').stem, 'b.tar')
1000 self.assertEqual(P('c:a/Some name. Ending with a dot.').stem,
1001 'Some name. Ending with a dot.')
1002
1003 def test_with_name(self):
1004 P = self.cls
1005 self.assertEqual(P('c:a/b').with_name('d.xml'), P('c:a/d.xml'))
1006 self.assertEqual(P('c:/a/b').with_name('d.xml'), P('c:/a/d.xml'))
1007 self.assertEqual(P('c:a/Dot ending.').with_name('d.xml'), P('c:a/d.xml'))
1008 self.assertEqual(P('c:/a/Dot ending.').with_name('d.xml'), P('c:/a/d.xml'))
1009 self.assertRaises(ValueError, P('c:').with_name, 'd.xml')
1010 self.assertRaises(ValueError, P('c:/').with_name, 'd.xml')
1011 self.assertRaises(ValueError, P('//My/Share').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -04001012 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:')
1013 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:e')
1014 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:/e')
1015 self.assertRaises(ValueError, P('c:a/b').with_name, '//My/Share')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001016
1017 def test_with_suffix(self):
1018 P = self.cls
1019 self.assertEqual(P('c:a/b').with_suffix('.gz'), P('c:a/b.gz'))
1020 self.assertEqual(P('c:/a/b').with_suffix('.gz'), P('c:/a/b.gz'))
1021 self.assertEqual(P('c:a/b.py').with_suffix('.gz'), P('c:a/b.gz'))
1022 self.assertEqual(P('c:/a/b.py').with_suffix('.gz'), P('c:/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001023 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001024 self.assertRaises(ValueError, P('').with_suffix, '.gz')
1025 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
1026 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
1027 self.assertRaises(ValueError, P('//My/Share').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +11001028 # Invalid suffix.
Antoine Pitrou1b02da92014-01-03 00:07:17 +01001029 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'gz')
1030 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/')
1031 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\')
1032 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:')
1033 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/.gz')
1034 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\.gz')
1035 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:.gz')
1036 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c/d')
1037 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c\\d')
1038 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c/d')
1039 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c\\d')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001040
1041 def test_relative_to(self):
1042 P = self.cls
Antoine Pitrou156b3612013-12-28 19:49:04 +01001043 p = P('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())
Anthony Shaw83da9262019-01-07 07:31:29 +11001051 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001052 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +01001053 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001054 self.assertRaises(ValueError, p.relative_to, P('d:'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001055 self.assertRaises(ValueError, p.relative_to, P('/'))
1056 self.assertRaises(ValueError, p.relative_to, P('Foo'))
1057 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1058 self.assertRaises(ValueError, p.relative_to, P('C:/Foo'))
1059 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Bar/Baz'))
1060 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Baz'))
1061 p = P('C:/Foo/Bar')
1062 self.assertEqual(p.relative_to(P('c:')), P('/Foo/Bar'))
1063 self.assertEqual(p.relative_to('c:'), P('/Foo/Bar'))
1064 self.assertEqual(str(p.relative_to(P('c:'))), '\\Foo\\Bar')
1065 self.assertEqual(str(p.relative_to('c:')), '\\Foo\\Bar')
1066 self.assertEqual(p.relative_to(P('c:/')), P('Foo/Bar'))
1067 self.assertEqual(p.relative_to('c:/'), P('Foo/Bar'))
1068 self.assertEqual(p.relative_to(P('c:/foO')), P('Bar'))
1069 self.assertEqual(p.relative_to('c:/foO'), P('Bar'))
1070 self.assertEqual(p.relative_to('c:/foO/'), P('Bar'))
1071 self.assertEqual(p.relative_to(P('c:/foO/baR')), P())
1072 self.assertEqual(p.relative_to('c:/foO/baR'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001073 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001074 self.assertRaises(ValueError, p.relative_to, P('C:/Baz'))
1075 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Bar/Baz'))
1076 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Baz'))
1077 self.assertRaises(ValueError, p.relative_to, P('C:Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001078 self.assertRaises(ValueError, p.relative_to, P('d:'))
1079 self.assertRaises(ValueError, p.relative_to, P('d:/'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001080 self.assertRaises(ValueError, p.relative_to, P('/'))
1081 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1082 self.assertRaises(ValueError, p.relative_to, P('//C/Foo'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001083 # UNC paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001084 p = P('//Server/Share/Foo/Bar')
1085 self.assertEqual(p.relative_to(P('//sErver/sHare')), P('Foo/Bar'))
1086 self.assertEqual(p.relative_to('//sErver/sHare'), P('Foo/Bar'))
1087 self.assertEqual(p.relative_to('//sErver/sHare/'), P('Foo/Bar'))
1088 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo')), P('Bar'))
1089 self.assertEqual(p.relative_to('//sErver/sHare/Foo'), P('Bar'))
1090 self.assertEqual(p.relative_to('//sErver/sHare/Foo/'), P('Bar'))
1091 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo/Bar')), P())
1092 self.assertEqual(p.relative_to('//sErver/sHare/Foo/Bar'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001093 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001094 self.assertRaises(ValueError, p.relative_to, P('/Server/Share/Foo'))
1095 self.assertRaises(ValueError, p.relative_to, P('c:/Server/Share/Foo'))
1096 self.assertRaises(ValueError, p.relative_to, P('//z/Share/Foo'))
1097 self.assertRaises(ValueError, p.relative_to, P('//Server/z/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001098
Hai Shi82642a02019-08-13 14:54:02 -05001099 def test_is_relative_to(self):
1100 P = self.cls
1101 p = P('C:Foo/Bar')
1102 self.assertTrue(p.is_relative_to(P('c:')))
1103 self.assertTrue(p.is_relative_to('c:'))
1104 self.assertTrue(p.is_relative_to(P('c:foO')))
1105 self.assertTrue(p.is_relative_to('c:foO'))
1106 self.assertTrue(p.is_relative_to('c:foO/'))
1107 self.assertTrue(p.is_relative_to(P('c:foO/baR')))
1108 self.assertTrue(p.is_relative_to('c:foO/baR'))
1109 # Unrelated paths.
1110 self.assertFalse(p.is_relative_to(P()))
1111 self.assertFalse(p.is_relative_to(''))
1112 self.assertFalse(p.is_relative_to(P('d:')))
1113 self.assertFalse(p.is_relative_to(P('/')))
1114 self.assertFalse(p.is_relative_to(P('Foo')))
1115 self.assertFalse(p.is_relative_to(P('/Foo')))
1116 self.assertFalse(p.is_relative_to(P('C:/Foo')))
1117 self.assertFalse(p.is_relative_to(P('C:Foo/Bar/Baz')))
1118 self.assertFalse(p.is_relative_to(P('C:Foo/Baz')))
1119 p = P('C:/Foo/Bar')
1120 self.assertTrue(p.is_relative_to('c:'))
1121 self.assertTrue(p.is_relative_to(P('c:/')))
1122 self.assertTrue(p.is_relative_to(P('c:/foO')))
1123 self.assertTrue(p.is_relative_to('c:/foO/'))
1124 self.assertTrue(p.is_relative_to(P('c:/foO/baR')))
1125 self.assertTrue(p.is_relative_to('c:/foO/baR'))
1126 # Unrelated paths.
1127 self.assertFalse(p.is_relative_to(P('C:/Baz')))
1128 self.assertFalse(p.is_relative_to(P('C:/Foo/Bar/Baz')))
1129 self.assertFalse(p.is_relative_to(P('C:/Foo/Baz')))
1130 self.assertFalse(p.is_relative_to(P('C:Foo')))
1131 self.assertFalse(p.is_relative_to(P('d:')))
1132 self.assertFalse(p.is_relative_to(P('d:/')))
1133 self.assertFalse(p.is_relative_to(P('/')))
1134 self.assertFalse(p.is_relative_to(P('/Foo')))
1135 self.assertFalse(p.is_relative_to(P('//C/Foo')))
1136 # UNC paths.
1137 p = P('//Server/Share/Foo/Bar')
1138 self.assertTrue(p.is_relative_to(P('//sErver/sHare')))
1139 self.assertTrue(p.is_relative_to('//sErver/sHare'))
1140 self.assertTrue(p.is_relative_to('//sErver/sHare/'))
1141 self.assertTrue(p.is_relative_to(P('//sErver/sHare/Foo')))
1142 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo'))
1143 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo/'))
1144 self.assertTrue(p.is_relative_to(P('//sErver/sHare/Foo/Bar')))
1145 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo/Bar'))
1146 # Unrelated paths.
1147 self.assertFalse(p.is_relative_to(P('/Server/Share/Foo')))
1148 self.assertFalse(p.is_relative_to(P('c:/Server/Share/Foo')))
1149 self.assertFalse(p.is_relative_to(P('//z/Share/Foo')))
1150 self.assertFalse(p.is_relative_to(P('//Server/z/Foo')))
1151
Antoine Pitrou31119e42013-11-22 17:38:12 +01001152 def test_is_absolute(self):
1153 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +11001154 # Under NT, only paths with both a drive and a root are absolute.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001155 self.assertFalse(P().is_absolute())
1156 self.assertFalse(P('a').is_absolute())
1157 self.assertFalse(P('a/b/').is_absolute())
1158 self.assertFalse(P('/').is_absolute())
1159 self.assertFalse(P('/a').is_absolute())
1160 self.assertFalse(P('/a/b/').is_absolute())
1161 self.assertFalse(P('c:').is_absolute())
1162 self.assertFalse(P('c:a').is_absolute())
1163 self.assertFalse(P('c:a/b/').is_absolute())
1164 self.assertTrue(P('c:/').is_absolute())
1165 self.assertTrue(P('c:/a').is_absolute())
1166 self.assertTrue(P('c:/a/b/').is_absolute())
Anthony Shaw83da9262019-01-07 07:31:29 +11001167 # UNC paths are absolute by definition.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001168 self.assertTrue(P('//a/b').is_absolute())
1169 self.assertTrue(P('//a/b/').is_absolute())
1170 self.assertTrue(P('//a/b/c').is_absolute())
1171 self.assertTrue(P('//a/b/c/d').is_absolute())
1172
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001173 def test_join(self):
1174 P = self.cls
1175 p = P('C:/a/b')
1176 pp = p.joinpath('x/y')
1177 self.assertEqual(pp, P('C:/a/b/x/y'))
1178 pp = p.joinpath('/x/y')
1179 self.assertEqual(pp, P('C:/x/y'))
1180 # Joining with a different drive => the first path is ignored, even
1181 # if the second path is relative.
1182 pp = p.joinpath('D:x/y')
1183 self.assertEqual(pp, P('D:x/y'))
1184 pp = p.joinpath('D:/x/y')
1185 self.assertEqual(pp, P('D:/x/y'))
1186 pp = p.joinpath('//host/share/x/y')
1187 self.assertEqual(pp, P('//host/share/x/y'))
1188 # Joining with the same drive => the first path is appended to if
1189 # the second path is relative.
1190 pp = p.joinpath('c:x/y')
1191 self.assertEqual(pp, P('C:/a/b/x/y'))
1192 pp = p.joinpath('c:/x/y')
1193 self.assertEqual(pp, P('C:/x/y'))
1194
1195 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001196 # Basically the same as joinpath().
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001197 P = self.cls
1198 p = P('C:/a/b')
1199 self.assertEqual(p / 'x/y', P('C:/a/b/x/y'))
1200 self.assertEqual(p / 'x' / 'y', P('C:/a/b/x/y'))
1201 self.assertEqual(p / '/x/y', P('C:/x/y'))
1202 self.assertEqual(p / '/x' / 'y', P('C:/x/y'))
1203 # Joining with a different drive => the first path is ignored, even
1204 # if the second path is relative.
1205 self.assertEqual(p / 'D:x/y', P('D:x/y'))
1206 self.assertEqual(p / 'D:' / 'x/y', P('D:x/y'))
1207 self.assertEqual(p / 'D:/x/y', P('D:/x/y'))
1208 self.assertEqual(p / 'D:' / '/x/y', P('D:/x/y'))
1209 self.assertEqual(p / '//host/share/x/y', P('//host/share/x/y'))
1210 # Joining with the same drive => the first path is appended to if
1211 # the second path is relative.
Serhiy Storchaka010ff582013-12-06 17:25:51 +02001212 self.assertEqual(p / 'c:x/y', P('C:/a/b/x/y'))
1213 self.assertEqual(p / 'c:/x/y', P('C:/x/y'))
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001214
Antoine Pitrou31119e42013-11-22 17:38:12 +01001215 def test_is_reserved(self):
1216 P = self.cls
1217 self.assertIs(False, P('').is_reserved())
1218 self.assertIs(False, P('/').is_reserved())
1219 self.assertIs(False, P('/foo/bar').is_reserved())
1220 self.assertIs(True, P('con').is_reserved())
1221 self.assertIs(True, P('NUL').is_reserved())
1222 self.assertIs(True, P('NUL.txt').is_reserved())
1223 self.assertIs(True, P('com1').is_reserved())
1224 self.assertIs(True, P('com9.bar').is_reserved())
1225 self.assertIs(False, P('bar.com9').is_reserved())
1226 self.assertIs(True, P('lpt1').is_reserved())
1227 self.assertIs(True, P('lpt9.bar').is_reserved())
1228 self.assertIs(False, P('bar.lpt9').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001229 # Only the last component matters.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001230 self.assertIs(False, P('c:/NUL/con/baz').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001231 # UNC paths are never reserved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001232 self.assertIs(False, P('//my/share/nul/con/aux').is_reserved())
1233
Antoine Pitrou31119e42013-11-22 17:38:12 +01001234class PurePathTest(_BasePurePathTest, unittest.TestCase):
1235 cls = pathlib.PurePath
1236
1237 def test_concrete_class(self):
1238 p = self.cls('a')
1239 self.assertIs(type(p),
1240 pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath)
1241
1242 def test_different_flavours_unequal(self):
1243 p = pathlib.PurePosixPath('a')
1244 q = pathlib.PureWindowsPath('a')
1245 self.assertNotEqual(p, q)
1246
1247 def test_different_flavours_unordered(self):
1248 p = pathlib.PurePosixPath('a')
1249 q = pathlib.PureWindowsPath('a')
1250 with self.assertRaises(TypeError):
1251 p < q
1252 with self.assertRaises(TypeError):
1253 p <= q
1254 with self.assertRaises(TypeError):
1255 p > q
1256 with self.assertRaises(TypeError):
1257 p >= q
1258
1259
1260#
Anthony Shaw83da9262019-01-07 07:31:29 +11001261# Tests for the concrete classes.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001262#
1263
Anthony Shaw83da9262019-01-07 07:31:29 +11001264# Make sure any symbolic links in the base test path are resolved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001265BASE = os.path.realpath(TESTFN)
1266join = lambda *x: os.path.join(BASE, *x)
1267rel_join = lambda *x: os.path.join(TESTFN, *x)
1268
Antoine Pitrou31119e42013-11-22 17:38:12 +01001269only_nt = unittest.skipIf(os.name != 'nt',
1270 'test requires a Windows-compatible system')
1271only_posix = unittest.skipIf(os.name == 'nt',
1272 'test requires a POSIX-compatible system')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001273
1274@only_posix
1275class PosixPathAsPureTest(PurePosixPathTest):
1276 cls = pathlib.PosixPath
1277
1278@only_nt
1279class WindowsPathAsPureTest(PureWindowsPathTest):
1280 cls = pathlib.WindowsPath
1281
Victor Stinnerd7569632016-03-11 22:53:00 +01001282 def test_owner(self):
1283 P = self.cls
1284 with self.assertRaises(NotImplementedError):
1285 P('c:/').owner()
1286
1287 def test_group(self):
1288 P = self.cls
1289 with self.assertRaises(NotImplementedError):
1290 P('c:/').group()
1291
Antoine Pitrou31119e42013-11-22 17:38:12 +01001292
1293class _BasePathTest(object):
1294 """Tests for the FS-accessing functionalities of the Path classes."""
1295
1296 # (BASE)
1297 # |
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001298 # |-- brokenLink -> non-existing
1299 # |-- dirA
1300 # | `-- linkC -> ../dirB
1301 # |-- dirB
1302 # | |-- fileB
1303 # | `-- linkD -> ../dirB
1304 # |-- dirC
1305 # | |-- dirD
1306 # | | `-- fileD
1307 # | `-- fileC
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001308 # |-- dirE # No permissions
Antoine Pitrou31119e42013-11-22 17:38:12 +01001309 # |-- fileA
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001310 # |-- linkA -> fileA
Jörg Stucked5c120f2019-05-21 19:44:40 +02001311 # |-- linkB -> dirB
1312 # `-- brokenLinkLoop -> brokenLinkLoop
Antoine Pitrou31119e42013-11-22 17:38:12 +01001313 #
1314
1315 def setUp(self):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001316 def cleanup():
1317 os.chmod(join('dirE'), 0o777)
1318 support.rmtree(BASE)
1319 self.addCleanup(cleanup)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001320 os.mkdir(BASE)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001321 os.mkdir(join('dirA'))
1322 os.mkdir(join('dirB'))
1323 os.mkdir(join('dirC'))
1324 os.mkdir(join('dirC', 'dirD'))
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001325 os.mkdir(join('dirE'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001326 with open(join('fileA'), 'wb') as f:
1327 f.write(b"this is file A\n")
1328 with open(join('dirB', 'fileB'), 'wb') as f:
1329 f.write(b"this is file B\n")
1330 with open(join('dirC', 'fileC'), 'wb') as f:
1331 f.write(b"this is file C\n")
1332 with open(join('dirC', 'dirD', 'fileD'), 'wb') as f:
1333 f.write(b"this is file D\n")
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001334 os.chmod(join('dirE'), 0)
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001335 if support.can_symlink():
Anthony Shaw83da9262019-01-07 07:31:29 +11001336 # Relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001337 os.symlink('fileA', join('linkA'))
1338 os.symlink('non-existing', join('brokenLink'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001339 self.dirlink('dirB', join('linkB'))
1340 self.dirlink(os.path.join('..', 'dirB'), join('dirA', 'linkC'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001341 # This one goes upwards, creating a loop.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001342 self.dirlink(os.path.join('..', 'dirB'), join('dirB', 'linkD'))
Jörg Stucked5c120f2019-05-21 19:44:40 +02001343 # Broken symlink (pointing to itself).
1344 os.symlink('brokenLinkLoop', join('brokenLinkLoop'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001345
1346 if os.name == 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11001347 # Workaround for http://bugs.python.org/issue13772.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001348 def dirlink(self, src, dest):
1349 os.symlink(src, dest, target_is_directory=True)
1350 else:
1351 def dirlink(self, src, dest):
1352 os.symlink(src, dest)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001353
1354 def assertSame(self, path_a, path_b):
1355 self.assertTrue(os.path.samefile(str(path_a), str(path_b)),
1356 "%r and %r don't point to the same file" %
1357 (path_a, path_b))
1358
1359 def assertFileNotFound(self, func, *args, **kwargs):
1360 with self.assertRaises(FileNotFoundError) as cm:
1361 func(*args, **kwargs)
1362 self.assertEqual(cm.exception.errno, errno.ENOENT)
1363
Steve Dower97d79062019-09-10 14:52:48 +01001364 def assertEqualNormCase(self, path_a, path_b):
1365 self.assertEqual(os.path.normcase(path_a), os.path.normcase(path_b))
1366
Antoine Pitrou31119e42013-11-22 17:38:12 +01001367 def _test_cwd(self, p):
1368 q = self.cls(os.getcwd())
1369 self.assertEqual(p, q)
Steve Dower97d79062019-09-10 14:52:48 +01001370 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001371 self.assertIs(type(p), type(q))
1372 self.assertTrue(p.is_absolute())
1373
1374 def test_cwd(self):
1375 p = self.cls.cwd()
1376 self._test_cwd(p)
1377
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001378 def _test_home(self, p):
1379 q = self.cls(os.path.expanduser('~'))
1380 self.assertEqual(p, q)
Steve Dower97d79062019-09-10 14:52:48 +01001381 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001382 self.assertIs(type(p), type(q))
1383 self.assertTrue(p.is_absolute())
1384
1385 def test_home(self):
1386 p = self.cls.home()
1387 self._test_home(p)
1388
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001389 def test_samefile(self):
1390 fileA_path = os.path.join(BASE, 'fileA')
1391 fileB_path = os.path.join(BASE, 'dirB', 'fileB')
1392 p = self.cls(fileA_path)
1393 pp = self.cls(fileA_path)
1394 q = self.cls(fileB_path)
1395 self.assertTrue(p.samefile(fileA_path))
1396 self.assertTrue(p.samefile(pp))
1397 self.assertFalse(p.samefile(fileB_path))
1398 self.assertFalse(p.samefile(q))
1399 # Test the non-existent file case
1400 non_existent = os.path.join(BASE, 'foo')
1401 r = self.cls(non_existent)
1402 self.assertRaises(FileNotFoundError, p.samefile, r)
1403 self.assertRaises(FileNotFoundError, p.samefile, non_existent)
1404 self.assertRaises(FileNotFoundError, r.samefile, p)
1405 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1406 self.assertRaises(FileNotFoundError, r.samefile, r)
1407 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1408
Antoine Pitrou31119e42013-11-22 17:38:12 +01001409 def test_empty_path(self):
1410 # The empty path points to '.'
1411 p = self.cls('')
1412 self.assertEqual(p.stat(), os.stat('.'))
1413
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001414 def test_expanduser_common(self):
1415 P = self.cls
1416 p = P('~')
1417 self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))
1418 p = P('foo')
1419 self.assertEqual(p.expanduser(), p)
1420 p = P('/~')
1421 self.assertEqual(p.expanduser(), p)
1422 p = P('../~')
1423 self.assertEqual(p.expanduser(), p)
1424 p = P(P('').absolute().anchor) / '~'
1425 self.assertEqual(p.expanduser(), p)
1426
Antoine Pitrou31119e42013-11-22 17:38:12 +01001427 def test_exists(self):
1428 P = self.cls
1429 p = P(BASE)
1430 self.assertIs(True, p.exists())
1431 self.assertIs(True, (p / 'dirA').exists())
1432 self.assertIs(True, (p / 'fileA').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001433 self.assertIs(False, (p / 'fileA' / 'bah').exists())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001434 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001435 self.assertIs(True, (p / 'linkA').exists())
1436 self.assertIs(True, (p / 'linkB').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001437 self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1438 self.assertIs(False, (p / 'linkA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001439 self.assertIs(False, (p / 'foo').exists())
1440 self.assertIs(False, P('/xyzzy').exists())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001441 self.assertIs(False, P(BASE + '\udfff').exists())
1442 self.assertIs(False, P(BASE + '\x00').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001443
1444 def test_open_common(self):
1445 p = self.cls(BASE)
1446 with (p / 'fileA').open('r') as f:
1447 self.assertIsInstance(f, io.TextIOBase)
1448 self.assertEqual(f.read(), "this is file A\n")
1449 with (p / 'fileA').open('rb') as f:
1450 self.assertIsInstance(f, io.BufferedIOBase)
1451 self.assertEqual(f.read().strip(), b"this is file A")
1452 with (p / 'fileA').open('rb', buffering=0) as f:
1453 self.assertIsInstance(f, io.RawIOBase)
1454 self.assertEqual(f.read().strip(), b"this is file A")
1455
Georg Brandlea683982014-10-01 19:12:33 +02001456 def test_read_write_bytes(self):
1457 p = self.cls(BASE)
1458 (p / 'fileA').write_bytes(b'abcdefg')
1459 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001460 # Check that trying to write str does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001461 self.assertRaises(TypeError, (p / 'fileA').write_bytes, 'somestr')
1462 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1463
1464 def test_read_write_text(self):
1465 p = self.cls(BASE)
1466 (p / 'fileA').write_text('äbcdefg', encoding='latin-1')
1467 self.assertEqual((p / 'fileA').read_text(
1468 encoding='utf-8', errors='ignore'), 'bcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001469 # Check that trying to write bytes does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001470 self.assertRaises(TypeError, (p / 'fileA').write_text, b'somebytes')
1471 self.assertEqual((p / 'fileA').read_text(encoding='latin-1'), 'äbcdefg')
1472
Antoine Pitrou31119e42013-11-22 17:38:12 +01001473 def test_iterdir(self):
1474 P = self.cls
1475 p = P(BASE)
1476 it = p.iterdir()
1477 paths = set(it)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001478 expected = ['dirA', 'dirB', 'dirC', 'dirE', 'fileA']
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001479 if support.can_symlink():
Jörg Stucked5c120f2019-05-21 19:44:40 +02001480 expected += ['linkA', 'linkB', 'brokenLink', 'brokenLinkLoop']
Antoine Pitrou31119e42013-11-22 17:38:12 +01001481 self.assertEqual(paths, { P(BASE, q) for q in expected })
1482
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001483 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001484 def test_iterdir_symlink(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001485 # __iter__ on a symlink to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001486 P = self.cls
1487 p = P(BASE, 'linkB')
1488 paths = set(p.iterdir())
1489 expected = { P(BASE, 'linkB', q) for q in ['fileB', 'linkD'] }
1490 self.assertEqual(paths, expected)
1491
1492 def test_iterdir_nodir(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001493 # __iter__ on something that is not a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001494 p = self.cls(BASE, 'fileA')
1495 with self.assertRaises(OSError) as cm:
1496 next(p.iterdir())
1497 # ENOENT or EINVAL under Windows, ENOTDIR otherwise
Anthony Shaw83da9262019-01-07 07:31:29 +11001498 # (see issue #12802).
Antoine Pitrou31119e42013-11-22 17:38:12 +01001499 self.assertIn(cm.exception.errno, (errno.ENOTDIR,
1500 errno.ENOENT, errno.EINVAL))
1501
1502 def test_glob_common(self):
1503 def _check(glob, expected):
1504 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1505 P = self.cls
1506 p = P(BASE)
1507 it = p.glob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001508 self.assertIsInstance(it, collections.abc.Iterator)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001509 _check(it, ["fileA"])
1510 _check(p.glob("fileB"), [])
1511 _check(p.glob("dir*/file*"), ["dirB/fileB", "dirC/fileC"])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001512 if not support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001513 _check(p.glob("*A"), ['dirA', 'fileA'])
1514 else:
1515 _check(p.glob("*A"), ['dirA', 'fileA', 'linkA'])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001516 if not support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001517 _check(p.glob("*B/*"), ['dirB/fileB'])
1518 else:
1519 _check(p.glob("*B/*"), ['dirB/fileB', 'dirB/linkD',
1520 'linkB/fileB', 'linkB/linkD'])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001521 if not support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001522 _check(p.glob("*/fileB"), ['dirB/fileB'])
1523 else:
1524 _check(p.glob("*/fileB"), ['dirB/fileB', 'linkB/fileB'])
1525
1526 def test_rglob_common(self):
1527 def _check(glob, expected):
1528 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1529 P = self.cls
1530 p = P(BASE)
1531 it = p.rglob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001532 self.assertIsInstance(it, collections.abc.Iterator)
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001533 _check(it, ["fileA"])
1534 _check(p.rglob("fileB"), ["dirB/fileB"])
1535 _check(p.rglob("*/fileA"), [])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001536 if not support.can_symlink():
Guido van Rossum9c39b672016-01-07 13:12:34 -08001537 _check(p.rglob("*/fileB"), ["dirB/fileB"])
1538 else:
1539 _check(p.rglob("*/fileB"), ["dirB/fileB", "dirB/linkD/fileB",
1540 "linkB/fileB", "dirA/linkC/fileB"])
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001541 _check(p.rglob("file*"), ["fileA", "dirB/fileB",
1542 "dirC/fileC", "dirC/dirD/fileD"])
Antoine Pitrou31119e42013-11-22 17:38:12 +01001543 p = P(BASE, "dirC")
1544 _check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
1545 _check(p.rglob("*/*"), ["dirC/dirD/fileD"])
1546
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001547 @support.skip_unless_symlink
Guido van Rossum69bfb152016-01-06 10:31:33 -08001548 def test_rglob_symlink_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001549 # Don't get fooled by symlink loops (Issue #26012).
Guido van Rossum69bfb152016-01-06 10:31:33 -08001550 P = self.cls
1551 p = P(BASE)
1552 given = set(p.rglob('*'))
1553 expect = {'brokenLink',
1554 'dirA', 'dirA/linkC',
1555 'dirB', 'dirB/fileB', 'dirB/linkD',
1556 'dirC', 'dirC/dirD', 'dirC/dirD/fileD', 'dirC/fileC',
1557 'dirE',
1558 'fileA',
1559 'linkA',
1560 'linkB',
Jörg Stucked5c120f2019-05-21 19:44:40 +02001561 'brokenLinkLoop',
Guido van Rossum69bfb152016-01-06 10:31:33 -08001562 }
1563 self.assertEqual(given, {p / x for x in expect})
1564
Antoine Pitrou31119e42013-11-22 17:38:12 +01001565 def test_glob_dotdot(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001566 # ".." is not special in globs.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001567 P = self.cls
1568 p = P(BASE)
1569 self.assertEqual(set(p.glob("..")), { P(BASE, "..") })
1570 self.assertEqual(set(p.glob("dirA/../file*")), { P(BASE, "dirA/../fileA") })
1571 self.assertEqual(set(p.glob("../xyzzy")), set())
1572
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001573
Steve Dower98eb3602016-11-09 12:58:17 -08001574 def _check_resolve(self, p, expected, strict=True):
1575 q = p.resolve(strict)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001576 self.assertEqual(q, expected)
1577
Anthony Shaw83da9262019-01-07 07:31:29 +11001578 # This can be used to check both relative and absolute resolutions.
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001579 _check_resolve_relative = _check_resolve_absolute = _check_resolve
Antoine Pitrou31119e42013-11-22 17:38:12 +01001580
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001581 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001582 def test_resolve_common(self):
1583 P = self.cls
1584 p = P(BASE, 'foo')
1585 with self.assertRaises(OSError) as cm:
Steve Dower98eb3602016-11-09 12:58:17 -08001586 p.resolve(strict=True)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001587 self.assertEqual(cm.exception.errno, errno.ENOENT)
Steve Dower98eb3602016-11-09 12:58:17 -08001588 # Non-strict
Steve Dower97d79062019-09-10 14:52:48 +01001589 self.assertEqualNormCase(str(p.resolve(strict=False)),
1590 os.path.join(BASE, 'foo'))
Steve Dower98eb3602016-11-09 12:58:17 -08001591 p = P(BASE, 'foo', 'in', 'spam')
Steve Dower97d79062019-09-10 14:52:48 +01001592 self.assertEqualNormCase(str(p.resolve(strict=False)),
1593 os.path.join(BASE, 'foo', 'in', 'spam'))
Steve Dower98eb3602016-11-09 12:58:17 -08001594 p = P(BASE, '..', 'foo', 'in', 'spam')
Steve Dower97d79062019-09-10 14:52:48 +01001595 self.assertEqualNormCase(str(p.resolve(strict=False)),
1596 os.path.abspath(os.path.join('foo', 'in', 'spam')))
Anthony Shaw83da9262019-01-07 07:31:29 +11001597 # These are all relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001598 p = P(BASE, 'dirB', 'fileB')
1599 self._check_resolve_relative(p, p)
1600 p = P(BASE, 'linkA')
1601 self._check_resolve_relative(p, P(BASE, 'fileA'))
1602 p = P(BASE, 'dirA', 'linkC', 'fileB')
1603 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1604 p = P(BASE, 'dirB', 'linkD', 'fileB')
1605 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001606 # Non-strict
1607 p = P(BASE, 'dirA', 'linkC', 'fileB', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001608 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB', 'foo', 'in',
1609 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001610 p = P(BASE, 'dirA', 'linkC', '..', 'foo', 'in', 'spam')
1611 if os.name == 'nt':
1612 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1613 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001614 self._check_resolve_relative(p, P(BASE, 'dirA', 'foo', 'in',
1615 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001616 else:
1617 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1618 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001619 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Anthony Shaw83da9262019-01-07 07:31:29 +11001620 # Now create absolute symlinks.
Steve Dower0cd63912018-12-10 18:52:57 -08001621 d = support._longpath(tempfile.mkdtemp(suffix='-dirD', dir=os.getcwd()))
Victor Stinnerec864692014-07-21 19:19:05 +02001622 self.addCleanup(support.rmtree, d)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001623 os.symlink(os.path.join(d), join('dirA', 'linkX'))
1624 os.symlink(join('dirB'), os.path.join(d, 'linkY'))
1625 p = P(BASE, 'dirA', 'linkX', 'linkY', 'fileB')
1626 self._check_resolve_absolute(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001627 # Non-strict
1628 p = P(BASE, 'dirA', 'linkX', 'linkY', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001629 self._check_resolve_relative(p, P(BASE, 'dirB', 'foo', 'in', 'spam'),
1630 False)
Steve Dower98eb3602016-11-09 12:58:17 -08001631 p = P(BASE, 'dirA', 'linkX', 'linkY', '..', 'foo', 'in', 'spam')
1632 if os.name == 'nt':
1633 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1634 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001635 self._check_resolve_relative(p, P(d, 'foo', 'in', 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001636 else:
1637 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1638 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001639 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001640
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001641 @support.skip_unless_symlink
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001642 def test_resolve_dot(self):
1643 # See https://bitbucket.org/pitrou/pathlib/issue/9/pathresolve-fails-on-complex-symlinks
1644 p = self.cls(BASE)
1645 self.dirlink('.', join('0'))
Antoine Pitroucc157512013-12-03 17:13:13 +01001646 self.dirlink(os.path.join('0', '0'), join('1'))
1647 self.dirlink(os.path.join('1', '1'), join('2'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001648 q = p / '2'
Steve Dower98eb3602016-11-09 12:58:17 -08001649 self.assertEqual(q.resolve(strict=True), p)
1650 r = q / '3' / '4'
1651 self.assertRaises(FileNotFoundError, r.resolve, strict=True)
1652 # Non-strict
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001653 self.assertEqual(r.resolve(strict=False), p / '3' / '4')
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001654
Antoine Pitrou31119e42013-11-22 17:38:12 +01001655 def test_with(self):
1656 p = self.cls(BASE)
1657 it = p.iterdir()
1658 it2 = p.iterdir()
1659 next(it2)
1660 with p:
1661 pass
Anthony Shaw83da9262019-01-07 07:31:29 +11001662 # I/O operation on closed path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001663 self.assertRaises(ValueError, next, it)
1664 self.assertRaises(ValueError, next, it2)
1665 self.assertRaises(ValueError, p.open)
1666 self.assertRaises(ValueError, p.resolve)
1667 self.assertRaises(ValueError, p.absolute)
1668 self.assertRaises(ValueError, p.__enter__)
1669
1670 def test_chmod(self):
1671 p = self.cls(BASE) / 'fileA'
1672 mode = p.stat().st_mode
Anthony Shaw83da9262019-01-07 07:31:29 +11001673 # Clear writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001674 new_mode = mode & ~0o222
1675 p.chmod(new_mode)
1676 self.assertEqual(p.stat().st_mode, new_mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11001677 # Set writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001678 new_mode = mode | 0o222
1679 p.chmod(new_mode)
1680 self.assertEqual(p.stat().st_mode, new_mode)
1681
Anthony Shaw83da9262019-01-07 07:31:29 +11001682 # XXX also need a test for lchmod.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001683
1684 def test_stat(self):
1685 p = self.cls(BASE) / 'fileA'
1686 st = p.stat()
1687 self.assertEqual(p.stat(), st)
Anthony Shaw83da9262019-01-07 07:31:29 +11001688 # Change file mode by flipping write bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001689 p.chmod(st.st_mode ^ 0o222)
1690 self.addCleanup(p.chmod, st.st_mode)
1691 self.assertNotEqual(p.stat(), st)
1692
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001693 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001694 def test_lstat(self):
1695 p = self.cls(BASE)/ 'linkA'
1696 st = p.stat()
1697 self.assertNotEqual(st, p.lstat())
1698
1699 def test_lstat_nosymlink(self):
1700 p = self.cls(BASE) / 'fileA'
1701 st = p.stat()
1702 self.assertEqual(st, p.lstat())
1703
1704 @unittest.skipUnless(pwd, "the pwd module is needed for this test")
1705 def test_owner(self):
1706 p = self.cls(BASE) / 'fileA'
1707 uid = p.stat().st_uid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001708 try:
1709 name = pwd.getpwuid(uid).pw_name
1710 except KeyError:
1711 self.skipTest(
1712 "user %d doesn't have an entry in the system database" % uid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001713 self.assertEqual(name, p.owner())
1714
1715 @unittest.skipUnless(grp, "the grp module is needed for this test")
1716 def test_group(self):
1717 p = self.cls(BASE) / 'fileA'
1718 gid = p.stat().st_gid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001719 try:
1720 name = grp.getgrgid(gid).gr_name
1721 except KeyError:
1722 self.skipTest(
1723 "group %d doesn't have an entry in the system database" % gid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001724 self.assertEqual(name, p.group())
1725
1726 def test_unlink(self):
1727 p = self.cls(BASE) / 'fileA'
1728 p.unlink()
1729 self.assertFileNotFound(p.stat)
1730 self.assertFileNotFound(p.unlink)
1731
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001732 def test_unlink_missing_ok(self):
1733 p = self.cls(BASE) / 'fileAAA'
1734 self.assertFileNotFound(p.unlink)
1735 p.unlink(missing_ok=True)
1736
Antoine Pitrou31119e42013-11-22 17:38:12 +01001737 def test_rmdir(self):
1738 p = self.cls(BASE) / 'dirA'
1739 for q in p.iterdir():
1740 q.unlink()
1741 p.rmdir()
1742 self.assertFileNotFound(p.stat)
1743 self.assertFileNotFound(p.unlink)
1744
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001745 def test_link_to(self):
1746 P = self.cls(BASE)
1747 p = P / 'fileA'
1748 size = p.stat().st_size
1749 # linking to another path.
1750 q = P / 'dirA' / 'fileAA'
1751 try:
1752 p.link_to(q)
1753 except PermissionError as e:
1754 self.skipTest('os.link(): %s' % e)
1755 self.assertEqual(q.stat().st_size, size)
1756 self.assertEqual(os.path.samefile(p, q), True)
1757 self.assertTrue(p.stat)
1758 # Linking to a str of a relative path.
1759 r = rel_join('fileAAA')
1760 q.link_to(r)
1761 self.assertEqual(os.stat(r).st_size, size)
1762 self.assertTrue(q.stat)
1763
Antoine Pitrou31119e42013-11-22 17:38:12 +01001764 def test_rename(self):
1765 P = self.cls(BASE)
1766 p = P / 'fileA'
1767 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11001768 # Renaming to another path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001769 q = P / 'dirA' / 'fileAA'
hui shang088a09a2019-09-11 21:26:49 +08001770 renamed_p = p.rename(q)
1771 self.assertEqual(renamed_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001772 self.assertEqual(q.stat().st_size, size)
1773 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11001774 # Renaming to a str of a relative path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001775 r = rel_join('fileAAA')
hui shang088a09a2019-09-11 21:26:49 +08001776 renamed_q = q.rename(r)
1777 self.assertEqual(renamed_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001778 self.assertEqual(os.stat(r).st_size, size)
1779 self.assertFileNotFound(q.stat)
1780
1781 def test_replace(self):
1782 P = self.cls(BASE)
1783 p = P / 'fileA'
1784 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11001785 # Replacing a non-existing path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001786 q = P / 'dirA' / 'fileAA'
hui shang088a09a2019-09-11 21:26:49 +08001787 replaced_p = p.replace(q)
1788 self.assertEqual(replaced_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001789 self.assertEqual(q.stat().st_size, size)
1790 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11001791 # Replacing another (existing) path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001792 r = rel_join('dirB', 'fileB')
hui shang088a09a2019-09-11 21:26:49 +08001793 replaced_q = q.replace(r)
1794 self.assertEqual(replaced_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001795 self.assertEqual(os.stat(r).st_size, size)
1796 self.assertFileNotFound(q.stat)
1797
1798 def test_touch_common(self):
1799 P = self.cls(BASE)
1800 p = P / 'newfileA'
1801 self.assertFalse(p.exists())
1802 p.touch()
1803 self.assertTrue(p.exists())
Antoine Pitrou0f575642013-11-22 23:20:08 +01001804 st = p.stat()
1805 old_mtime = st.st_mtime
1806 old_mtime_ns = st.st_mtime_ns
Antoine Pitrou31119e42013-11-22 17:38:12 +01001807 # Rewind the mtime sufficiently far in the past to work around
1808 # filesystem-specific timestamp granularity.
1809 os.utime(str(p), (old_mtime - 10, old_mtime - 10))
Anthony Shaw83da9262019-01-07 07:31:29 +11001810 # The file mtime should be refreshed by calling touch() again.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001811 p.touch()
Antoine Pitrou0f575642013-11-22 23:20:08 +01001812 st = p.stat()
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001813 self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)
1814 self.assertGreaterEqual(st.st_mtime, old_mtime)
Anthony Shaw83da9262019-01-07 07:31:29 +11001815 # Now with exist_ok=False.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001816 p = P / 'newfileB'
1817 self.assertFalse(p.exists())
1818 p.touch(mode=0o700, exist_ok=False)
1819 self.assertTrue(p.exists())
1820 self.assertRaises(OSError, p.touch, exist_ok=False)
1821
Antoine Pitrou8b784932013-11-23 14:52:39 +01001822 def test_touch_nochange(self):
1823 P = self.cls(BASE)
1824 p = P / 'fileA'
1825 p.touch()
1826 with p.open('rb') as f:
1827 self.assertEqual(f.read().strip(), b"this is file A")
1828
Antoine Pitrou31119e42013-11-22 17:38:12 +01001829 def test_mkdir(self):
1830 P = self.cls(BASE)
1831 p = P / 'newdirA'
1832 self.assertFalse(p.exists())
1833 p.mkdir()
1834 self.assertTrue(p.exists())
1835 self.assertTrue(p.is_dir())
1836 with self.assertRaises(OSError) as cm:
1837 p.mkdir()
1838 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001839
1840 def test_mkdir_parents(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001841 # Creating a chain of directories.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001842 p = self.cls(BASE, 'newdirB', 'newdirC')
1843 self.assertFalse(p.exists())
1844 with self.assertRaises(OSError) as cm:
1845 p.mkdir()
1846 self.assertEqual(cm.exception.errno, errno.ENOENT)
1847 p.mkdir(parents=True)
1848 self.assertTrue(p.exists())
1849 self.assertTrue(p.is_dir())
1850 with self.assertRaises(OSError) as cm:
1851 p.mkdir(parents=True)
1852 self.assertEqual(cm.exception.errno, errno.EEXIST)
Anthony Shaw83da9262019-01-07 07:31:29 +11001853 # Test `mode` arg.
1854 mode = stat.S_IMODE(p.stat().st_mode) # Default mode.
Antoine Pitrou0048c982013-12-16 20:22:37 +01001855 p = self.cls(BASE, 'newdirD', 'newdirE')
1856 p.mkdir(0o555, parents=True)
1857 self.assertTrue(p.exists())
1858 self.assertTrue(p.is_dir())
1859 if os.name != 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11001860 # The directory's permissions follow the mode argument.
Gregory P. Smithb599c612014-01-20 01:10:33 -08001861 self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11001862 # The parent's permissions follow the default process settings.
Antoine Pitrou0048c982013-12-16 20:22:37 +01001863 self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001864
Barry Warsaw7c549c42014-08-05 11:28:12 -04001865 def test_mkdir_exist_ok(self):
1866 p = self.cls(BASE, 'dirB')
1867 st_ctime_first = p.stat().st_ctime
1868 self.assertTrue(p.exists())
1869 self.assertTrue(p.is_dir())
1870 with self.assertRaises(FileExistsError) as cm:
1871 p.mkdir()
1872 self.assertEqual(cm.exception.errno, errno.EEXIST)
1873 p.mkdir(exist_ok=True)
1874 self.assertTrue(p.exists())
1875 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1876
1877 def test_mkdir_exist_ok_with_parent(self):
1878 p = self.cls(BASE, 'dirC')
1879 self.assertTrue(p.exists())
1880 with self.assertRaises(FileExistsError) as cm:
1881 p.mkdir()
1882 self.assertEqual(cm.exception.errno, errno.EEXIST)
1883 p = p / 'newdirC'
1884 p.mkdir(parents=True)
1885 st_ctime_first = p.stat().st_ctime
1886 self.assertTrue(p.exists())
1887 with self.assertRaises(FileExistsError) as cm:
1888 p.mkdir(parents=True)
1889 self.assertEqual(cm.exception.errno, errno.EEXIST)
1890 p.mkdir(parents=True, exist_ok=True)
1891 self.assertTrue(p.exists())
1892 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1893
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001894 def test_mkdir_exist_ok_root(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001895 # Issue #25803: A drive root could raise PermissionError on Windows.
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001896 self.cls('/').resolve().mkdir(exist_ok=True)
1897 self.cls('/').resolve().mkdir(parents=True, exist_ok=True)
1898
Anthony Shaw83da9262019-01-07 07:31:29 +11001899 @only_nt # XXX: not sure how to test this on POSIX.
Steve Dowerd3c48532017-02-04 14:54:56 -08001900 def test_mkdir_with_unknown_drive(self):
1901 for d in 'ZYXWVUTSRQPONMLKJIHGFEDCBA':
1902 p = self.cls(d + ':\\')
1903 if not p.is_dir():
1904 break
1905 else:
1906 self.skipTest("cannot find a drive that doesn't exist")
1907 with self.assertRaises(OSError):
1908 (p / 'child' / 'path').mkdir(parents=True)
1909
Barry Warsaw7c549c42014-08-05 11:28:12 -04001910 def test_mkdir_with_child_file(self):
1911 p = self.cls(BASE, 'dirB', 'fileB')
1912 self.assertTrue(p.exists())
1913 # An exception is raised when the last path component is an existing
1914 # regular file, regardless of whether exist_ok is true or not.
1915 with self.assertRaises(FileExistsError) as cm:
1916 p.mkdir(parents=True)
1917 self.assertEqual(cm.exception.errno, errno.EEXIST)
1918 with self.assertRaises(FileExistsError) as cm:
1919 p.mkdir(parents=True, exist_ok=True)
1920 self.assertEqual(cm.exception.errno, errno.EEXIST)
1921
1922 def test_mkdir_no_parents_file(self):
1923 p = self.cls(BASE, 'fileA')
1924 self.assertTrue(p.exists())
1925 # An exception is raised when the last path component is an existing
1926 # regular file, regardless of whether exist_ok is true or not.
1927 with self.assertRaises(FileExistsError) as cm:
1928 p.mkdir()
1929 self.assertEqual(cm.exception.errno, errno.EEXIST)
1930 with self.assertRaises(FileExistsError) as cm:
1931 p.mkdir(exist_ok=True)
1932 self.assertEqual(cm.exception.errno, errno.EEXIST)
1933
Armin Rigo22a594a2017-04-13 20:08:15 +02001934 def test_mkdir_concurrent_parent_creation(self):
1935 for pattern_num in range(32):
1936 p = self.cls(BASE, 'dirCPC%d' % pattern_num)
1937 self.assertFalse(p.exists())
1938
1939 def my_mkdir(path, mode=0o777):
1940 path = str(path)
1941 # Emulate another process that would create the directory
1942 # just before we try to create it ourselves. We do it
1943 # in all possible pattern combinations, assuming that this
1944 # function is called at most 5 times (dirCPC/dir1/dir2,
1945 # dirCPC/dir1, dirCPC, dirCPC/dir1, dirCPC/dir1/dir2).
1946 if pattern.pop():
Anthony Shaw83da9262019-01-07 07:31:29 +11001947 os.mkdir(path, mode) # From another process.
Armin Rigo22a594a2017-04-13 20:08:15 +02001948 concurrently_created.add(path)
Anthony Shaw83da9262019-01-07 07:31:29 +11001949 os.mkdir(path, mode) # Our real call.
Armin Rigo22a594a2017-04-13 20:08:15 +02001950
1951 pattern = [bool(pattern_num & (1 << n)) for n in range(5)]
1952 concurrently_created = set()
1953 p12 = p / 'dir1' / 'dir2'
1954 try:
1955 with mock.patch("pathlib._normal_accessor.mkdir", my_mkdir):
1956 p12.mkdir(parents=True, exist_ok=False)
1957 except FileExistsError:
1958 self.assertIn(str(p12), concurrently_created)
1959 else:
1960 self.assertNotIn(str(p12), concurrently_created)
1961 self.assertTrue(p.exists())
1962
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001963 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001964 def test_symlink_to(self):
1965 P = self.cls(BASE)
1966 target = P / 'fileA'
Anthony Shaw83da9262019-01-07 07:31:29 +11001967 # Symlinking a path target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001968 link = P / 'dirA' / 'linkAA'
1969 link.symlink_to(target)
1970 self.assertEqual(link.stat(), target.stat())
1971 self.assertNotEqual(link.lstat(), target.stat())
Anthony Shaw83da9262019-01-07 07:31:29 +11001972 # Symlinking a str target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001973 link = P / 'dirA' / 'linkAAA'
1974 link.symlink_to(str(target))
1975 self.assertEqual(link.stat(), target.stat())
1976 self.assertNotEqual(link.lstat(), target.stat())
1977 self.assertFalse(link.is_dir())
Anthony Shaw83da9262019-01-07 07:31:29 +11001978 # Symlinking to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001979 target = P / 'dirB'
1980 link = P / 'dirA' / 'linkAAAA'
1981 link.symlink_to(target, target_is_directory=True)
1982 self.assertEqual(link.stat(), target.stat())
1983 self.assertNotEqual(link.lstat(), target.stat())
1984 self.assertTrue(link.is_dir())
1985 self.assertTrue(list(link.iterdir()))
1986
1987 def test_is_dir(self):
1988 P = self.cls(BASE)
1989 self.assertTrue((P / 'dirA').is_dir())
1990 self.assertFalse((P / 'fileA').is_dir())
1991 self.assertFalse((P / 'non-existing').is_dir())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001992 self.assertFalse((P / 'fileA' / 'bah').is_dir())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001993 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001994 self.assertFalse((P / 'linkA').is_dir())
1995 self.assertTrue((P / 'linkB').is_dir())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001996 self.assertFalse((P/ 'brokenLink').is_dir(), False)
1997 self.assertIs((P / 'dirA\udfff').is_dir(), False)
1998 self.assertIs((P / 'dirA\x00').is_dir(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001999
2000 def test_is_file(self):
2001 P = self.cls(BASE)
2002 self.assertTrue((P / 'fileA').is_file())
2003 self.assertFalse((P / 'dirA').is_file())
2004 self.assertFalse((P / 'non-existing').is_file())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002005 self.assertFalse((P / 'fileA' / 'bah').is_file())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002006 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002007 self.assertTrue((P / 'linkA').is_file())
2008 self.assertFalse((P / 'linkB').is_file())
2009 self.assertFalse((P/ 'brokenLink').is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002010 self.assertIs((P / 'fileA\udfff').is_file(), False)
2011 self.assertIs((P / 'fileA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002012
Cooper Lees173ff4a2017-08-01 15:35:45 -07002013 @only_posix
2014 def test_is_mount(self):
2015 P = self.cls(BASE)
Anthony Shaw83da9262019-01-07 07:31:29 +11002016 R = self.cls('/') # TODO: Work out Windows.
Cooper Lees173ff4a2017-08-01 15:35:45 -07002017 self.assertFalse((P / 'fileA').is_mount())
2018 self.assertFalse((P / 'dirA').is_mount())
2019 self.assertFalse((P / 'non-existing').is_mount())
2020 self.assertFalse((P / 'fileA' / 'bah').is_mount())
2021 self.assertTrue(R.is_mount())
2022 if support.can_symlink():
2023 self.assertFalse((P / 'linkA').is_mount())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002024 self.assertIs(self.cls('/\udfff').is_mount(), False)
2025 self.assertIs(self.cls('/\x00').is_mount(), False)
Cooper Lees173ff4a2017-08-01 15:35:45 -07002026
Antoine Pitrou31119e42013-11-22 17:38:12 +01002027 def test_is_symlink(self):
2028 P = self.cls(BASE)
2029 self.assertFalse((P / 'fileA').is_symlink())
2030 self.assertFalse((P / 'dirA').is_symlink())
2031 self.assertFalse((P / 'non-existing').is_symlink())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002032 self.assertFalse((P / 'fileA' / 'bah').is_symlink())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002033 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002034 self.assertTrue((P / 'linkA').is_symlink())
2035 self.assertTrue((P / 'linkB').is_symlink())
2036 self.assertTrue((P/ 'brokenLink').is_symlink())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002037 self.assertIs((P / 'fileA\udfff').is_file(), False)
2038 self.assertIs((P / 'fileA\x00').is_file(), False)
2039 if support.can_symlink():
2040 self.assertIs((P / 'linkA\udfff').is_file(), False)
2041 self.assertIs((P / 'linkA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002042
2043 def test_is_fifo_false(self):
2044 P = self.cls(BASE)
2045 self.assertFalse((P / 'fileA').is_fifo())
2046 self.assertFalse((P / 'dirA').is_fifo())
2047 self.assertFalse((P / 'non-existing').is_fifo())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002048 self.assertFalse((P / 'fileA' / 'bah').is_fifo())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002049 self.assertIs((P / 'fileA\udfff').is_fifo(), False)
2050 self.assertIs((P / 'fileA\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002051
2052 @unittest.skipUnless(hasattr(os, "mkfifo"), "os.mkfifo() required")
2053 def test_is_fifo_true(self):
2054 P = self.cls(BASE, 'myfifo')
xdegaye92c2ca72017-11-12 17:31:07 +01002055 try:
2056 os.mkfifo(str(P))
2057 except PermissionError as e:
2058 self.skipTest('os.mkfifo(): %s' % e)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002059 self.assertTrue(P.is_fifo())
2060 self.assertFalse(P.is_socket())
2061 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002062 self.assertIs(self.cls(BASE, 'myfifo\udfff').is_fifo(), False)
2063 self.assertIs(self.cls(BASE, 'myfifo\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002064
2065 def test_is_socket_false(self):
2066 P = self.cls(BASE)
2067 self.assertFalse((P / 'fileA').is_socket())
2068 self.assertFalse((P / 'dirA').is_socket())
2069 self.assertFalse((P / 'non-existing').is_socket())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002070 self.assertFalse((P / 'fileA' / 'bah').is_socket())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002071 self.assertIs((P / 'fileA\udfff').is_socket(), False)
2072 self.assertIs((P / 'fileA\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002073
2074 @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required")
2075 def test_is_socket_true(self):
2076 P = self.cls(BASE, 'mysock')
Antoine Pitrou330ce592013-11-22 18:05:06 +01002077 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002078 self.addCleanup(sock.close)
Antoine Pitrou330ce592013-11-22 18:05:06 +01002079 try:
2080 sock.bind(str(P))
2081 except OSError as e:
Xavier de Gayee88ed052016-12-14 11:52:28 +01002082 if (isinstance(e, PermissionError) or
2083 "AF_UNIX path too long" in str(e)):
Antoine Pitrou330ce592013-11-22 18:05:06 +01002084 self.skipTest("cannot bind Unix socket: " + str(e))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002085 self.assertTrue(P.is_socket())
2086 self.assertFalse(P.is_fifo())
2087 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002088 self.assertIs(self.cls(BASE, 'mysock\udfff').is_socket(), False)
2089 self.assertIs(self.cls(BASE, 'mysock\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002090
2091 def test_is_block_device_false(self):
2092 P = self.cls(BASE)
2093 self.assertFalse((P / 'fileA').is_block_device())
2094 self.assertFalse((P / 'dirA').is_block_device())
2095 self.assertFalse((P / 'non-existing').is_block_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002096 self.assertFalse((P / 'fileA' / 'bah').is_block_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002097 self.assertIs((P / 'fileA\udfff').is_block_device(), False)
2098 self.assertIs((P / 'fileA\x00').is_block_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002099
2100 def test_is_char_device_false(self):
2101 P = self.cls(BASE)
2102 self.assertFalse((P / 'fileA').is_char_device())
2103 self.assertFalse((P / 'dirA').is_char_device())
2104 self.assertFalse((P / 'non-existing').is_char_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002105 self.assertFalse((P / 'fileA' / 'bah').is_char_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002106 self.assertIs((P / 'fileA\udfff').is_char_device(), False)
2107 self.assertIs((P / 'fileA\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002108
2109 def test_is_char_device_true(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002110 # Under Unix, /dev/null should generally be a char device.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002111 P = self.cls('/dev/null')
2112 if not P.exists():
2113 self.skipTest("/dev/null required")
2114 self.assertTrue(P.is_char_device())
2115 self.assertFalse(P.is_block_device())
2116 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002117 self.assertIs(self.cls('/dev/null\udfff').is_char_device(), False)
2118 self.assertIs(self.cls('/dev/null\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002119
2120 def test_pickling_common(self):
2121 p = self.cls(BASE, 'fileA')
2122 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
2123 dumped = pickle.dumps(p, proto)
2124 pp = pickle.loads(dumped)
2125 self.assertEqual(pp.stat(), p.stat())
2126
2127 def test_parts_interning(self):
2128 P = self.cls
2129 p = P('/usr/bin/foo')
2130 q = P('/usr/local/bin')
2131 # 'usr'
2132 self.assertIs(p.parts[1], q.parts[1])
2133 # 'bin'
2134 self.assertIs(p.parts[2], q.parts[3])
2135
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002136 def _check_complex_symlinks(self, link0_target):
Anthony Shaw83da9262019-01-07 07:31:29 +11002137 # Test solving a non-looping chain of symlinks (issue #19887).
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002138 P = self.cls(BASE)
2139 self.dirlink(os.path.join('link0', 'link0'), join('link1'))
2140 self.dirlink(os.path.join('link1', 'link1'), join('link2'))
2141 self.dirlink(os.path.join('link2', 'link2'), join('link3'))
2142 self.dirlink(link0_target, join('link0'))
2143
Anthony Shaw83da9262019-01-07 07:31:29 +11002144 # Resolve absolute paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002145 p = (P / 'link0').resolve()
2146 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002147 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002148 p = (P / 'link1').resolve()
2149 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002150 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002151 p = (P / 'link2').resolve()
2152 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002153 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002154 p = (P / 'link3').resolve()
2155 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002156 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002157
Anthony Shaw83da9262019-01-07 07:31:29 +11002158 # Resolve relative paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002159 old_path = os.getcwd()
2160 os.chdir(BASE)
2161 try:
2162 p = self.cls('link0').resolve()
2163 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002164 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002165 p = self.cls('link1').resolve()
2166 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002167 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002168 p = self.cls('link2').resolve()
2169 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002170 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002171 p = self.cls('link3').resolve()
2172 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002173 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002174 finally:
2175 os.chdir(old_path)
2176
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002177 @support.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002178 def test_complex_symlinks_absolute(self):
2179 self._check_complex_symlinks(BASE)
2180
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002181 @support.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002182 def test_complex_symlinks_relative(self):
2183 self._check_complex_symlinks('.')
2184
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002185 @support.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002186 def test_complex_symlinks_relative_dot_dot(self):
2187 self._check_complex_symlinks(os.path.join('dirA', '..'))
2188
Antoine Pitrou31119e42013-11-22 17:38:12 +01002189
2190class PathTest(_BasePathTest, unittest.TestCase):
2191 cls = pathlib.Path
2192
2193 def test_concrete_class(self):
2194 p = self.cls('a')
2195 self.assertIs(type(p),
2196 pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath)
2197
2198 def test_unsupported_flavour(self):
2199 if os.name == 'nt':
2200 self.assertRaises(NotImplementedError, pathlib.PosixPath)
2201 else:
2202 self.assertRaises(NotImplementedError, pathlib.WindowsPath)
2203
Berker Peksag4a208e42016-01-30 17:50:48 +02002204 def test_glob_empty_pattern(self):
2205 p = self.cls()
2206 with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
2207 list(p.glob(''))
2208
Antoine Pitrou31119e42013-11-22 17:38:12 +01002209
2210@only_posix
2211class PosixPathTest(_BasePathTest, unittest.TestCase):
2212 cls = pathlib.PosixPath
2213
Steve Dower98eb3602016-11-09 12:58:17 -08002214 def _check_symlink_loop(self, *args, strict=True):
Antoine Pitrou31119e42013-11-22 17:38:12 +01002215 path = self.cls(*args)
2216 with self.assertRaises(RuntimeError):
Steve Dower98eb3602016-11-09 12:58:17 -08002217 print(path.resolve(strict))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002218
2219 def test_open_mode(self):
2220 old_mask = os.umask(0)
2221 self.addCleanup(os.umask, old_mask)
2222 p = self.cls(BASE)
2223 with (p / 'new_file').open('wb'):
2224 pass
2225 st = os.stat(join('new_file'))
2226 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2227 os.umask(0o022)
2228 with (p / 'other_new_file').open('wb'):
2229 pass
2230 st = os.stat(join('other_new_file'))
2231 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2232
2233 def test_touch_mode(self):
2234 old_mask = os.umask(0)
2235 self.addCleanup(os.umask, old_mask)
2236 p = self.cls(BASE)
2237 (p / 'new_file').touch()
2238 st = os.stat(join('new_file'))
2239 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2240 os.umask(0o022)
2241 (p / 'other_new_file').touch()
2242 st = os.stat(join('other_new_file'))
2243 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2244 (p / 'masked_new_file').touch(mode=0o750)
2245 st = os.stat(join('masked_new_file'))
2246 self.assertEqual(stat.S_IMODE(st.st_mode), 0o750)
2247
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002248 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01002249 def test_resolve_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002250 # Loops with relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002251 os.symlink('linkX/inside', join('linkX'))
2252 self._check_symlink_loop(BASE, 'linkX')
2253 os.symlink('linkY', join('linkY'))
2254 self._check_symlink_loop(BASE, 'linkY')
2255 os.symlink('linkZ/../linkZ', join('linkZ'))
2256 self._check_symlink_loop(BASE, 'linkZ')
Steve Dower98eb3602016-11-09 12:58:17 -08002257 # Non-strict
2258 self._check_symlink_loop(BASE, 'linkZ', 'foo', strict=False)
Anthony Shaw83da9262019-01-07 07:31:29 +11002259 # Loops with absolute symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002260 os.symlink(join('linkU/inside'), join('linkU'))
2261 self._check_symlink_loop(BASE, 'linkU')
2262 os.symlink(join('linkV'), join('linkV'))
2263 self._check_symlink_loop(BASE, 'linkV')
2264 os.symlink(join('linkW/../linkW'), join('linkW'))
2265 self._check_symlink_loop(BASE, 'linkW')
Steve Dower98eb3602016-11-09 12:58:17 -08002266 # Non-strict
2267 self._check_symlink_loop(BASE, 'linkW', 'foo', strict=False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002268
2269 def test_glob(self):
2270 P = self.cls
2271 p = P(BASE)
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002272 given = set(p.glob("FILEa"))
2273 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2274 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002275 self.assertEqual(set(p.glob("FILEa*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002276
2277 def test_rglob(self):
2278 P = self.cls
2279 p = P(BASE, "dirC")
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002280 given = set(p.rglob("FILEd"))
2281 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2282 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002283 self.assertEqual(set(p.rglob("FILEd*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002284
Xavier de Gayefb24eea2016-12-13 09:11:38 +01002285 @unittest.skipUnless(hasattr(pwd, 'getpwall'),
2286 'pwd module does not expose getpwall()')
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002287 def test_expanduser(self):
2288 P = self.cls
2289 support.import_module('pwd')
2290 import pwd
2291 pwdent = pwd.getpwuid(os.getuid())
2292 username = pwdent.pw_name
Serhiy Storchakaa3fd0b22016-05-03 21:17:03 +03002293 userhome = pwdent.pw_dir.rstrip('/') or '/'
Anthony Shaw83da9262019-01-07 07:31:29 +11002294 # Find arbitrary different user (if exists).
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002295 for pwdent in pwd.getpwall():
2296 othername = pwdent.pw_name
2297 otherhome = pwdent.pw_dir.rstrip('/')
Victor Stinnere9694392015-01-10 09:00:20 +01002298 if othername != username and otherhome:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002299 break
Anders Kaseorg5c0d4622018-05-14 10:00:37 -04002300 else:
2301 othername = username
2302 otherhome = userhome
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002303
2304 p1 = P('~/Documents')
2305 p2 = P('~' + username + '/Documents')
2306 p3 = P('~' + othername + '/Documents')
2307 p4 = P('../~' + username + '/Documents')
2308 p5 = P('/~' + username + '/Documents')
2309 p6 = P('')
2310 p7 = P('~fakeuser/Documents')
2311
2312 with support.EnvironmentVarGuard() as env:
2313 env.pop('HOME', None)
2314
2315 self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
2316 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2317 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2318 self.assertEqual(p4.expanduser(), p4)
2319 self.assertEqual(p5.expanduser(), p5)
2320 self.assertEqual(p6.expanduser(), p6)
2321 self.assertRaises(RuntimeError, p7.expanduser)
2322
2323 env['HOME'] = '/tmp'
2324 self.assertEqual(p1.expanduser(), P('/tmp/Documents'))
2325 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2326 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2327 self.assertEqual(p4.expanduser(), p4)
2328 self.assertEqual(p5.expanduser(), p5)
2329 self.assertEqual(p6.expanduser(), p6)
2330 self.assertRaises(RuntimeError, p7.expanduser)
2331
Przemysław Spodymek216b7452018-08-27 23:33:45 +02002332 @unittest.skipIf(sys.platform != "darwin",
2333 "Bad file descriptor in /dev/fd affects only macOS")
2334 def test_handling_bad_descriptor(self):
2335 try:
2336 file_descriptors = list(pathlib.Path('/dev/fd').rglob("*"))[3:]
2337 if not file_descriptors:
2338 self.skipTest("no file descriptors - issue was not reproduced")
2339 # Checking all file descriptors because there is no guarantee
2340 # which one will fail.
2341 for f in file_descriptors:
2342 f.exists()
2343 f.is_dir()
2344 f.is_file()
2345 f.is_symlink()
2346 f.is_block_device()
2347 f.is_char_device()
2348 f.is_fifo()
2349 f.is_socket()
2350 except OSError as e:
2351 if e.errno == errno.EBADF:
2352 self.fail("Bad file descriptor not handled.")
2353 raise
2354
Antoine Pitrou31119e42013-11-22 17:38:12 +01002355
2356@only_nt
2357class WindowsPathTest(_BasePathTest, unittest.TestCase):
2358 cls = pathlib.WindowsPath
2359
2360 def test_glob(self):
2361 P = self.cls
2362 p = P(BASE)
2363 self.assertEqual(set(p.glob("FILEa")), { P(BASE, "fileA") })
2364
2365 def test_rglob(self):
2366 P = self.cls
2367 p = P(BASE, "dirC")
2368 self.assertEqual(set(p.rglob("FILEd")), { P(BASE, "dirC/dirD/fileD") })
2369
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002370 def test_expanduser(self):
2371 P = self.cls
2372 with support.EnvironmentVarGuard() as env:
2373 env.pop('HOME', None)
2374 env.pop('USERPROFILE', None)
2375 env.pop('HOMEPATH', None)
2376 env.pop('HOMEDRIVE', None)
2377 env['USERNAME'] = 'alice'
2378
2379 # test that the path returns unchanged
2380 p1 = P('~/My Documents')
2381 p2 = P('~alice/My Documents')
2382 p3 = P('~bob/My Documents')
2383 p4 = P('/~/My Documents')
2384 p5 = P('d:~/My Documents')
2385 p6 = P('')
2386 self.assertRaises(RuntimeError, p1.expanduser)
2387 self.assertRaises(RuntimeError, p2.expanduser)
2388 self.assertRaises(RuntimeError, p3.expanduser)
2389 self.assertEqual(p4.expanduser(), p4)
2390 self.assertEqual(p5.expanduser(), p5)
2391 self.assertEqual(p6.expanduser(), p6)
2392
2393 def check():
2394 env.pop('USERNAME', None)
2395 self.assertEqual(p1.expanduser(),
2396 P('C:/Users/alice/My Documents'))
2397 self.assertRaises(KeyError, p2.expanduser)
2398 env['USERNAME'] = 'alice'
2399 self.assertEqual(p2.expanduser(),
2400 P('C:/Users/alice/My Documents'))
2401 self.assertEqual(p3.expanduser(),
2402 P('C:/Users/bob/My Documents'))
2403 self.assertEqual(p4.expanduser(), p4)
2404 self.assertEqual(p5.expanduser(), p5)
2405 self.assertEqual(p6.expanduser(), p6)
2406
Anthony Shaw83da9262019-01-07 07:31:29 +11002407 # Test the first lookup key in the env vars.
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002408 env['HOME'] = 'C:\\Users\\alice'
2409 check()
2410
Anthony Shaw83da9262019-01-07 07:31:29 +11002411 # Test that HOMEPATH is available instead.
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002412 env.pop('HOME', None)
2413 env['HOMEPATH'] = 'C:\\Users\\alice'
2414 check()
2415
2416 env['HOMEDRIVE'] = 'C:\\'
2417 env['HOMEPATH'] = 'Users\\alice'
2418 check()
2419
2420 env.pop('HOMEDRIVE', None)
2421 env.pop('HOMEPATH', None)
2422 env['USERPROFILE'] = 'C:\\Users\\alice'
2423 check()
2424
Antoine Pitrou31119e42013-11-22 17:38:12 +01002425
aiudirog4c69be22019-08-08 01:41:10 -04002426class CompatiblePathTest(unittest.TestCase):
2427 """
2428 Test that a type can be made compatible with PurePath
2429 derivatives by implementing division operator overloads.
2430 """
2431
2432 class CompatPath:
2433 """
2434 Minimum viable class to test PurePath compatibility.
2435 Simply uses the division operator to join a given
2436 string and the string value of another object with
2437 a forward slash.
2438 """
2439 def __init__(self, string):
2440 self.string = string
2441
2442 def __truediv__(self, other):
2443 return type(self)(f"{self.string}/{other}")
2444
2445 def __rtruediv__(self, other):
2446 return type(self)(f"{other}/{self.string}")
2447
2448 def test_truediv(self):
2449 result = pathlib.PurePath("test") / self.CompatPath("right")
2450 self.assertIsInstance(result, self.CompatPath)
2451 self.assertEqual(result.string, "test/right")
2452
2453 with self.assertRaises(TypeError):
2454 # Verify improper operations still raise a TypeError
2455 pathlib.PurePath("test") / 10
2456
2457 def test_rtruediv(self):
2458 result = self.CompatPath("left") / pathlib.PurePath("test")
2459 self.assertIsInstance(result, self.CompatPath)
2460 self.assertEqual(result.string, "left/test")
2461
2462 with self.assertRaises(TypeError):
2463 # Verify improper operations still raise a TypeError
2464 10 / pathlib.PurePath("test")
2465
2466
Antoine Pitrou31119e42013-11-22 17:38:12 +01002467if __name__ == "__main__":
2468 unittest.main()