blob: f1451796b6427dbff48bcda50f613e2048241035 [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
Hai Shibb0424b2020-08-04 00:47:42 +080014from test.support import import_helper
15from test.support import os_helper
16from test.support.os_helper import TESTFN, FakePath
Antoine Pitrou31119e42013-11-22 17:38:12 +010017
18try:
19 import grp, pwd
20except ImportError:
21 grp = pwd = None
22
23
24class _BaseFlavourTest(object):
25
26 def _check_parse_parts(self, arg, expected):
27 f = self.flavour.parse_parts
28 sep = self.flavour.sep
29 altsep = self.flavour.altsep
30 actual = f([x.replace('/', sep) for x in arg])
31 self.assertEqual(actual, expected)
32 if altsep:
33 actual = f([x.replace('/', altsep) for x in arg])
34 self.assertEqual(actual, expected)
35
36 def test_parse_parts_common(self):
37 check = self._check_parse_parts
38 sep = self.flavour.sep
Anthony Shaw83da9262019-01-07 07:31:29 +110039 # Unanchored parts.
Antoine Pitrou31119e42013-11-22 17:38:12 +010040 check([], ('', '', []))
41 check(['a'], ('', '', ['a']))
42 check(['a/'], ('', '', ['a']))
43 check(['a', 'b'], ('', '', ['a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110044 # Expansion.
Antoine Pitrou31119e42013-11-22 17:38:12 +010045 check(['a/b'], ('', '', ['a', 'b']))
46 check(['a/b/'], ('', '', ['a', 'b']))
47 check(['a', 'b/c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +110048 # Collapsing and stripping excess slashes.
Antoine Pitrou31119e42013-11-22 17:38:12 +010049 check(['a', 'b//c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
50 check(['a', 'b/c/', 'd'], ('', '', ['a', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +110051 # Eliminating standalone dots.
Antoine Pitrou31119e42013-11-22 17:38:12 +010052 check(['.'], ('', '', []))
53 check(['.', '.', 'b'], ('', '', ['b']))
54 check(['a', '.', 'b'], ('', '', ['a', 'b']))
55 check(['a', '.', '.'], ('', '', ['a']))
Anthony Shaw83da9262019-01-07 07:31:29 +110056 # The first part is anchored.
Antoine Pitrou31119e42013-11-22 17:38:12 +010057 check(['/a/b'], ('', sep, [sep, 'a', 'b']))
58 check(['/a', 'b'], ('', sep, [sep, 'a', 'b']))
59 check(['/a/', 'b'], ('', sep, [sep, 'a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110060 # Ignoring parts before an anchored part.
Antoine Pitrou31119e42013-11-22 17:38:12 +010061 check(['a', '/b', 'c'], ('', sep, [sep, 'b', 'c']))
62 check(['a', '/b', '/c'], ('', sep, [sep, 'c']))
63
64
65class PosixFlavourTest(_BaseFlavourTest, unittest.TestCase):
66 flavour = pathlib._posix_flavour
67
68 def test_parse_parts(self):
69 check = self._check_parse_parts
70 # Collapsing of excess leading slashes, except for the double-slash
71 # special case.
72 check(['//a', 'b'], ('', '//', ['//', 'a', 'b']))
73 check(['///a', 'b'], ('', '/', ['/', 'a', 'b']))
74 check(['////a', 'b'], ('', '/', ['/', 'a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110075 # Paths which look like NT paths aren't treated specially.
Antoine Pitrou31119e42013-11-22 17:38:12 +010076 check(['c:a'], ('', '', ['c:a']))
77 check(['c:\\a'], ('', '', ['c:\\a']))
78 check(['\\a'], ('', '', ['\\a']))
79
80 def test_splitroot(self):
81 f = self.flavour.splitroot
82 self.assertEqual(f(''), ('', '', ''))
83 self.assertEqual(f('a'), ('', '', 'a'))
84 self.assertEqual(f('a/b'), ('', '', 'a/b'))
85 self.assertEqual(f('a/b/'), ('', '', 'a/b/'))
86 self.assertEqual(f('/a'), ('', '/', 'a'))
87 self.assertEqual(f('/a/b'), ('', '/', 'a/b'))
88 self.assertEqual(f('/a/b/'), ('', '/', 'a/b/'))
89 # The root is collapsed when there are redundant slashes
90 # except when there are exactly two leading slashes, which
91 # is a special case in POSIX.
92 self.assertEqual(f('//a'), ('', '//', 'a'))
93 self.assertEqual(f('///a'), ('', '/', 'a'))
94 self.assertEqual(f('///a/b'), ('', '/', 'a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +110095 # Paths which look like NT paths aren't treated specially.
Antoine Pitrou31119e42013-11-22 17:38:12 +010096 self.assertEqual(f('c:/a/b'), ('', '', 'c:/a/b'))
97 self.assertEqual(f('\\/a/b'), ('', '', '\\/a/b'))
98 self.assertEqual(f('\\a\\b'), ('', '', '\\a\\b'))
99
100
101class NTFlavourTest(_BaseFlavourTest, unittest.TestCase):
102 flavour = pathlib._windows_flavour
103
104 def test_parse_parts(self):
105 check = self._check_parse_parts
Anthony Shaw83da9262019-01-07 07:31:29 +1100106 # First part is anchored.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100107 check(['c:'], ('c:', '', ['c:']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100108 check(['c:/'], ('c:', '\\', ['c:\\']))
109 check(['/'], ('', '\\', ['\\']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100110 check(['c:a'], ('c:', '', ['c:', 'a']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100111 check(['c:/a'], ('c:', '\\', ['c:\\', 'a']))
112 check(['/a'], ('', '\\', ['\\', 'a']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100113 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100114 check(['//a/b'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
115 check(['//a/b/'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
116 check(['//a/b/c'], ('\\\\a\\b', '\\', ['\\\\a\\b\\', 'c']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100117 # Second part is anchored, so that the first part is ignored.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100118 check(['a', 'Z:b', 'c'], ('Z:', '', ['Z:', 'b', 'c']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100119 check(['a', 'Z:/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100120 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100121 check(['a', '//b/c', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100122 # Collapsing and stripping excess slashes.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100123 check(['a', 'Z://b//c/', 'd/'], ('Z:', '\\', ['Z:\\', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100124 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100125 check(['a', '//b/c//', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100126 # Extended paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100127 check(['//?/c:/'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\']))
128 check(['//?/c:/a'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'a']))
129 check(['//?/c:/a', '/b'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100130 # Extended UNC paths (format is "\\?\UNC\server\share").
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100131 check(['//?/UNC/b/c'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\']))
132 check(['//?/UNC/b/c/d'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100133 # Second part has a root but not drive.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100134 check(['a', '/b', 'c'], ('', '\\', ['\\', 'b', 'c']))
135 check(['Z:/a', '/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
136 check(['//?/Z:/a', '/b', 'c'], ('\\\\?\\Z:', '\\', ['\\\\?\\Z:\\', 'b', 'c']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100137
138 def test_splitroot(self):
139 f = self.flavour.splitroot
140 self.assertEqual(f(''), ('', '', ''))
141 self.assertEqual(f('a'), ('', '', 'a'))
142 self.assertEqual(f('a\\b'), ('', '', 'a\\b'))
143 self.assertEqual(f('\\a'), ('', '\\', 'a'))
144 self.assertEqual(f('\\a\\b'), ('', '\\', 'a\\b'))
145 self.assertEqual(f('c:a\\b'), ('c:', '', 'a\\b'))
146 self.assertEqual(f('c:\\a\\b'), ('c:', '\\', 'a\\b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100147 # Redundant slashes in the root are collapsed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100148 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
149 self.assertEqual(f('\\\\\\a/b'), ('', '\\', 'a/b'))
150 self.assertEqual(f('c:\\\\a'), ('c:', '\\', 'a'))
151 self.assertEqual(f('c:\\\\\\a/b'), ('c:', '\\', 'a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100152 # Valid UNC paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100153 self.assertEqual(f('\\\\a\\b'), ('\\\\a\\b', '\\', ''))
154 self.assertEqual(f('\\\\a\\b\\'), ('\\\\a\\b', '\\', ''))
155 self.assertEqual(f('\\\\a\\b\\c\\d'), ('\\\\a\\b', '\\', 'c\\d'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100156 # These are non-UNC paths (according to ntpath.py and test_ntpath).
Antoine Pitrou31119e42013-11-22 17:38:12 +0100157 # However, command.com says such paths are invalid, so it's
Anthony Shaw83da9262019-01-07 07:31:29 +1100158 # difficult to know what the right semantics are.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100159 self.assertEqual(f('\\\\\\a\\b'), ('', '\\', 'a\\b'))
160 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
161
162
163#
Anthony Shaw83da9262019-01-07 07:31:29 +1100164# Tests for the pure classes.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100165#
166
167class _BasePurePathTest(object):
168
Anthony Shaw83da9262019-01-07 07:31:29 +1100169 # Keys are canonical paths, values are list of tuples of arguments
170 # supposed to produce equal paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100171 equivalences = {
172 'a/b': [
173 ('a', 'b'), ('a/', 'b'), ('a', 'b/'), ('a/', 'b/'),
174 ('a/b/',), ('a//b',), ('a//b//',),
Anthony Shaw83da9262019-01-07 07:31:29 +1100175 # Empty components get removed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100176 ('', 'a', 'b'), ('a', '', 'b'), ('a', 'b', ''),
177 ],
178 '/b/c/d': [
179 ('a', '/b/c', 'd'), ('a', '///b//c', 'd/'),
180 ('/a', '/b/c', 'd'),
Anthony Shaw83da9262019-01-07 07:31:29 +1100181 # Empty components get removed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100182 ('/', 'b', '', 'c/d'), ('/', '', 'b/c/d'), ('', '/b/c/d'),
183 ],
184 }
185
186 def setUp(self):
187 p = self.cls('a')
188 self.flavour = p._flavour
189 self.sep = self.flavour.sep
190 self.altsep = self.flavour.altsep
191
192 def test_constructor_common(self):
193 P = self.cls
194 p = P('a')
195 self.assertIsInstance(p, P)
196 P('a', 'b', 'c')
197 P('/a', 'b', 'c')
198 P('a/b/c')
199 P('/a/b/c')
Serhiy Storchakab21d1552018-03-02 11:53:51 +0200200 P(FakePath("a/b/c"))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100201 self.assertEqual(P(P('a')), P('a'))
202 self.assertEqual(P(P('a'), 'b'), P('a/b'))
203 self.assertEqual(P(P('a'), P('b')), P('a/b'))
Serhiy Storchakab21d1552018-03-02 11:53:51 +0200204 self.assertEqual(P(P('a'), P('b'), P('c')), P(FakePath("a/b/c")))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100205
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200206 def _check_str_subclass(self, *args):
207 # Issue #21127: it should be possible to construct a PurePath object
Serhiy Storchaka6a7b3a72016-04-17 08:32:47 +0300208 # from a str subclass instance, and it then gets converted to
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200209 # a pure str object.
210 class StrSubclass(str):
211 pass
212 P = self.cls
213 p = P(*(StrSubclass(x) for x in args))
214 self.assertEqual(p, P(*args))
215 for part in p.parts:
216 self.assertIs(type(part), str)
217
218 def test_str_subclass_common(self):
219 self._check_str_subclass('')
220 self._check_str_subclass('.')
221 self._check_str_subclass('a')
222 self._check_str_subclass('a/b.txt')
223 self._check_str_subclass('/a/b.txt')
224
Antoine Pitrou31119e42013-11-22 17:38:12 +0100225 def test_join_common(self):
226 P = self.cls
227 p = P('a/b')
228 pp = p.joinpath('c')
229 self.assertEqual(pp, P('a/b/c'))
230 self.assertIs(type(pp), type(p))
231 pp = p.joinpath('c', 'd')
232 self.assertEqual(pp, P('a/b/c/d'))
233 pp = p.joinpath(P('c'))
234 self.assertEqual(pp, P('a/b/c'))
235 pp = p.joinpath('/c')
236 self.assertEqual(pp, P('/c'))
237
238 def test_div_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100239 # Basically the same as joinpath().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100240 P = self.cls
241 p = P('a/b')
242 pp = p / 'c'
243 self.assertEqual(pp, P('a/b/c'))
244 self.assertIs(type(pp), type(p))
245 pp = p / 'c/d'
246 self.assertEqual(pp, P('a/b/c/d'))
247 pp = p / 'c' / 'd'
248 self.assertEqual(pp, P('a/b/c/d'))
249 pp = 'c' / p / 'd'
250 self.assertEqual(pp, P('c/a/b/d'))
251 pp = p / P('c')
252 self.assertEqual(pp, P('a/b/c'))
253 pp = p/ '/c'
254 self.assertEqual(pp, P('/c'))
255
256 def _check_str(self, expected, args):
257 p = self.cls(*args)
258 self.assertEqual(str(p), expected.replace('/', self.sep))
259
260 def test_str_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100261 # Canonicalized paths roundtrip.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100262 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
263 self._check_str(pathstr, (pathstr,))
Anthony Shaw83da9262019-01-07 07:31:29 +1100264 # Special case for the empty path.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100265 self._check_str('.', ('',))
Anthony Shaw83da9262019-01-07 07:31:29 +1100266 # Other tests for str() are in test_equivalences().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100267
268 def test_as_posix_common(self):
269 P = self.cls
270 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
271 self.assertEqual(P(pathstr).as_posix(), pathstr)
Anthony Shaw83da9262019-01-07 07:31:29 +1100272 # Other tests for as_posix() are in test_equivalences().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100273
274 def test_as_bytes_common(self):
275 sep = os.fsencode(self.sep)
276 P = self.cls
277 self.assertEqual(bytes(P('a/b')), b'a' + sep + b'b')
278
279 def test_as_uri_common(self):
280 P = self.cls
281 with self.assertRaises(ValueError):
282 P('a').as_uri()
283 with self.assertRaises(ValueError):
284 P().as_uri()
285
286 def test_repr_common(self):
287 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
288 p = self.cls(pathstr)
289 clsname = p.__class__.__name__
290 r = repr(p)
Anthony Shaw83da9262019-01-07 07:31:29 +1100291 # The repr() is in the form ClassName("forward-slashes path").
Antoine Pitrou31119e42013-11-22 17:38:12 +0100292 self.assertTrue(r.startswith(clsname + '('), r)
293 self.assertTrue(r.endswith(')'), r)
294 inner = r[len(clsname) + 1 : -1]
295 self.assertEqual(eval(inner), p.as_posix())
Anthony Shaw83da9262019-01-07 07:31:29 +1100296 # The repr() roundtrips.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100297 q = eval(r, pathlib.__dict__)
298 self.assertIs(q.__class__, p.__class__)
299 self.assertEqual(q, p)
300 self.assertEqual(repr(q), r)
301
302 def test_eq_common(self):
303 P = self.cls
304 self.assertEqual(P('a/b'), P('a/b'))
305 self.assertEqual(P('a/b'), P('a', 'b'))
306 self.assertNotEqual(P('a/b'), P('a'))
307 self.assertNotEqual(P('a/b'), P('/a/b'))
308 self.assertNotEqual(P('a/b'), P())
309 self.assertNotEqual(P('/a/b'), P('/'))
310 self.assertNotEqual(P(), P('/'))
311 self.assertNotEqual(P(), "")
312 self.assertNotEqual(P(), {})
313 self.assertNotEqual(P(), int)
314
315 def test_match_common(self):
316 P = self.cls
317 self.assertRaises(ValueError, P('a').match, '')
318 self.assertRaises(ValueError, P('a').match, '.')
Anthony Shaw83da9262019-01-07 07:31:29 +1100319 # Simple relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100320 self.assertTrue(P('b.py').match('b.py'))
321 self.assertTrue(P('a/b.py').match('b.py'))
322 self.assertTrue(P('/a/b.py').match('b.py'))
323 self.assertFalse(P('a.py').match('b.py'))
324 self.assertFalse(P('b/py').match('b.py'))
325 self.assertFalse(P('/a.py').match('b.py'))
326 self.assertFalse(P('b.py/c').match('b.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100327 # Wilcard relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100328 self.assertTrue(P('b.py').match('*.py'))
329 self.assertTrue(P('a/b.py').match('*.py'))
330 self.assertTrue(P('/a/b.py').match('*.py'))
331 self.assertFalse(P('b.pyc').match('*.py'))
332 self.assertFalse(P('b./py').match('*.py'))
333 self.assertFalse(P('b.py/c').match('*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100334 # Multi-part relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100335 self.assertTrue(P('ab/c.py').match('a*/*.py'))
336 self.assertTrue(P('/d/ab/c.py').match('a*/*.py'))
337 self.assertFalse(P('a.py').match('a*/*.py'))
338 self.assertFalse(P('/dab/c.py').match('a*/*.py'))
339 self.assertFalse(P('ab/c.py/d').match('a*/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100340 # Absolute pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100341 self.assertTrue(P('/b.py').match('/*.py'))
342 self.assertFalse(P('b.py').match('/*.py'))
343 self.assertFalse(P('a/b.py').match('/*.py'))
344 self.assertFalse(P('/a/b.py').match('/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100345 # Multi-part absolute pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100346 self.assertTrue(P('/a/b.py').match('/a/*.py'))
347 self.assertFalse(P('/ab.py').match('/a/*.py'))
348 self.assertFalse(P('/a/b/c.py').match('/a/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100349 # Multi-part glob-style pattern.
350 self.assertFalse(P('/a/b/c.py').match('/**/*.py'))
351 self.assertTrue(P('/a/b/c.py').match('/a/**/*.py'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100352
353 def test_ordering_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100354 # Ordering is tuple-alike.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100355 def assertLess(a, b):
356 self.assertLess(a, b)
357 self.assertGreater(b, a)
358 P = self.cls
359 a = P('a')
360 b = P('a/b')
361 c = P('abc')
362 d = P('b')
363 assertLess(a, b)
364 assertLess(a, c)
365 assertLess(a, d)
366 assertLess(b, c)
367 assertLess(c, d)
368 P = self.cls
369 a = P('/a')
370 b = P('/a/b')
371 c = P('/abc')
372 d = P('/b')
373 assertLess(a, b)
374 assertLess(a, c)
375 assertLess(a, d)
376 assertLess(b, c)
377 assertLess(c, d)
378 with self.assertRaises(TypeError):
379 P() < {}
380
381 def test_parts_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100382 # `parts` returns a tuple.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100383 sep = self.sep
384 P = self.cls
385 p = P('a/b')
386 parts = p.parts
387 self.assertEqual(parts, ('a', 'b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100388 # The object gets reused.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100389 self.assertIs(parts, p.parts)
Anthony Shaw83da9262019-01-07 07:31:29 +1100390 # When the path is absolute, the anchor is a separate part.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100391 p = P('/a/b')
392 parts = p.parts
393 self.assertEqual(parts, (sep, 'a', 'b'))
394
Brett Cannon568be632016-06-10 12:20:49 -0700395 def test_fspath_common(self):
396 P = self.cls
397 p = P('a/b')
398 self._check_str(p.__fspath__(), ('a/b',))
399 self._check_str(os.fspath(p), ('a/b',))
400
Antoine Pitrou31119e42013-11-22 17:38:12 +0100401 def test_equivalences(self):
402 for k, tuples in self.equivalences.items():
403 canon = k.replace('/', self.sep)
404 posix = k.replace(self.sep, '/')
405 if canon != posix:
406 tuples = tuples + [
407 tuple(part.replace('/', self.sep) for part in t)
408 for t in tuples
409 ]
410 tuples.append((posix, ))
411 pcanon = self.cls(canon)
412 for t in tuples:
413 p = self.cls(*t)
414 self.assertEqual(p, pcanon, "failed with args {}".format(t))
415 self.assertEqual(hash(p), hash(pcanon))
416 self.assertEqual(str(p), canon)
417 self.assertEqual(p.as_posix(), posix)
418
419 def test_parent_common(self):
420 # Relative
421 P = self.cls
422 p = P('a/b/c')
423 self.assertEqual(p.parent, P('a/b'))
424 self.assertEqual(p.parent.parent, P('a'))
425 self.assertEqual(p.parent.parent.parent, P())
426 self.assertEqual(p.parent.parent.parent.parent, P())
427 # Anchored
428 p = P('/a/b/c')
429 self.assertEqual(p.parent, P('/a/b'))
430 self.assertEqual(p.parent.parent, P('/a'))
431 self.assertEqual(p.parent.parent.parent, P('/'))
432 self.assertEqual(p.parent.parent.parent.parent, P('/'))
433
434 def test_parents_common(self):
435 # Relative
436 P = self.cls
437 p = P('a/b/c')
438 par = p.parents
439 self.assertEqual(len(par), 3)
440 self.assertEqual(par[0], P('a/b'))
441 self.assertEqual(par[1], P('a'))
442 self.assertEqual(par[2], P('.'))
Joshua Cannon45205842020-11-20 09:40:39 -0600443 self.assertEqual(par[0:1], (P('a/b'),))
444 self.assertEqual(par[:2], (P('a/b'), P('a')))
445 self.assertEqual(par[:-1], (P('a/b'), P('a')))
446 self.assertEqual(par[1:], (P('a'), P('.')))
447 self.assertEqual(par[::2], (P('a/b'), P('.')))
448 self.assertEqual(par[::-1], (P('.'), P('a'), P('a/b')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100449 self.assertEqual(list(par), [P('a/b'), P('a'), P('.')])
450 with self.assertRaises(IndexError):
451 par[-1]
452 with self.assertRaises(IndexError):
453 par[3]
454 with self.assertRaises(TypeError):
455 par[0] = p
456 # Anchored
457 p = P('/a/b/c')
458 par = p.parents
459 self.assertEqual(len(par), 3)
460 self.assertEqual(par[0], P('/a/b'))
461 self.assertEqual(par[1], P('/a'))
462 self.assertEqual(par[2], P('/'))
Joshua Cannon45205842020-11-20 09:40:39 -0600463 self.assertEqual(par[0:1], (P('/a/b'),))
464 self.assertEqual(par[:2], (P('/a/b'), P('/a')))
465 self.assertEqual(par[:-1], (P('/a/b'), P('/a')))
466 self.assertEqual(par[1:], (P('/a'), P('/')))
467 self.assertEqual(par[::2], (P('/a/b'), P('/')))
468 self.assertEqual(par[::-1], (P('/'), P('/a'), P('/a/b')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100469 self.assertEqual(list(par), [P('/a/b'), P('/a'), P('/')])
470 with self.assertRaises(IndexError):
471 par[3]
472
473 def test_drive_common(self):
474 P = self.cls
475 self.assertEqual(P('a/b').drive, '')
476 self.assertEqual(P('/a/b').drive, '')
477 self.assertEqual(P('').drive, '')
478
479 def test_root_common(self):
480 P = self.cls
481 sep = self.sep
482 self.assertEqual(P('').root, '')
483 self.assertEqual(P('a/b').root, '')
484 self.assertEqual(P('/').root, sep)
485 self.assertEqual(P('/a/b').root, sep)
486
487 def test_anchor_common(self):
488 P = self.cls
489 sep = self.sep
490 self.assertEqual(P('').anchor, '')
491 self.assertEqual(P('a/b').anchor, '')
492 self.assertEqual(P('/').anchor, sep)
493 self.assertEqual(P('/a/b').anchor, sep)
494
495 def test_name_common(self):
496 P = self.cls
497 self.assertEqual(P('').name, '')
498 self.assertEqual(P('.').name, '')
499 self.assertEqual(P('/').name, '')
500 self.assertEqual(P('a/b').name, 'b')
501 self.assertEqual(P('/a/b').name, 'b')
502 self.assertEqual(P('/a/b/.').name, 'b')
503 self.assertEqual(P('a/b.py').name, 'b.py')
504 self.assertEqual(P('/a/b.py').name, 'b.py')
505
506 def test_suffix_common(self):
507 P = self.cls
508 self.assertEqual(P('').suffix, '')
509 self.assertEqual(P('.').suffix, '')
510 self.assertEqual(P('..').suffix, '')
511 self.assertEqual(P('/').suffix, '')
512 self.assertEqual(P('a/b').suffix, '')
513 self.assertEqual(P('/a/b').suffix, '')
514 self.assertEqual(P('/a/b/.').suffix, '')
515 self.assertEqual(P('a/b.py').suffix, '.py')
516 self.assertEqual(P('/a/b.py').suffix, '.py')
517 self.assertEqual(P('a/.hgrc').suffix, '')
518 self.assertEqual(P('/a/.hgrc').suffix, '')
519 self.assertEqual(P('a/.hg.rc').suffix, '.rc')
520 self.assertEqual(P('/a/.hg.rc').suffix, '.rc')
521 self.assertEqual(P('a/b.tar.gz').suffix, '.gz')
522 self.assertEqual(P('/a/b.tar.gz').suffix, '.gz')
523 self.assertEqual(P('a/Some name. Ending with a dot.').suffix, '')
524 self.assertEqual(P('/a/Some name. Ending with a dot.').suffix, '')
525
526 def test_suffixes_common(self):
527 P = self.cls
528 self.assertEqual(P('').suffixes, [])
529 self.assertEqual(P('.').suffixes, [])
530 self.assertEqual(P('/').suffixes, [])
531 self.assertEqual(P('a/b').suffixes, [])
532 self.assertEqual(P('/a/b').suffixes, [])
533 self.assertEqual(P('/a/b/.').suffixes, [])
534 self.assertEqual(P('a/b.py').suffixes, ['.py'])
535 self.assertEqual(P('/a/b.py').suffixes, ['.py'])
536 self.assertEqual(P('a/.hgrc').suffixes, [])
537 self.assertEqual(P('/a/.hgrc').suffixes, [])
538 self.assertEqual(P('a/.hg.rc').suffixes, ['.rc'])
539 self.assertEqual(P('/a/.hg.rc').suffixes, ['.rc'])
540 self.assertEqual(P('a/b.tar.gz').suffixes, ['.tar', '.gz'])
541 self.assertEqual(P('/a/b.tar.gz').suffixes, ['.tar', '.gz'])
542 self.assertEqual(P('a/Some name. Ending with a dot.').suffixes, [])
543 self.assertEqual(P('/a/Some name. Ending with a dot.').suffixes, [])
544
545 def test_stem_common(self):
546 P = self.cls
547 self.assertEqual(P('').stem, '')
548 self.assertEqual(P('.').stem, '')
549 self.assertEqual(P('..').stem, '..')
550 self.assertEqual(P('/').stem, '')
551 self.assertEqual(P('a/b').stem, 'b')
552 self.assertEqual(P('a/b.py').stem, 'b')
553 self.assertEqual(P('a/.hgrc').stem, '.hgrc')
554 self.assertEqual(P('a/.hg.rc').stem, '.hg')
555 self.assertEqual(P('a/b.tar.gz').stem, 'b.tar')
556 self.assertEqual(P('a/Some name. Ending with a dot.').stem,
557 'Some name. Ending with a dot.')
558
559 def test_with_name_common(self):
560 P = self.cls
561 self.assertEqual(P('a/b').with_name('d.xml'), P('a/d.xml'))
562 self.assertEqual(P('/a/b').with_name('d.xml'), P('/a/d.xml'))
563 self.assertEqual(P('a/b.py').with_name('d.xml'), P('a/d.xml'))
564 self.assertEqual(P('/a/b.py').with_name('d.xml'), P('/a/d.xml'))
565 self.assertEqual(P('a/Dot ending.').with_name('d.xml'), P('a/d.xml'))
566 self.assertEqual(P('/a/Dot ending.').with_name('d.xml'), P('/a/d.xml'))
567 self.assertRaises(ValueError, P('').with_name, 'd.xml')
568 self.assertRaises(ValueError, P('.').with_name, 'd.xml')
569 self.assertRaises(ValueError, P('/').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400570 self.assertRaises(ValueError, P('a/b').with_name, '')
571 self.assertRaises(ValueError, P('a/b').with_name, '/c')
572 self.assertRaises(ValueError, P('a/b').with_name, 'c/')
573 self.assertRaises(ValueError, P('a/b').with_name, 'c/d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100574
Tim Hoffmann8aea4b32020-04-19 17:29:49 +0200575 def test_with_stem_common(self):
576 P = self.cls
577 self.assertEqual(P('a/b').with_stem('d'), P('a/d'))
578 self.assertEqual(P('/a/b').with_stem('d'), P('/a/d'))
579 self.assertEqual(P('a/b.py').with_stem('d'), P('a/d.py'))
580 self.assertEqual(P('/a/b.py').with_stem('d'), P('/a/d.py'))
581 self.assertEqual(P('/a/b.tar.gz').with_stem('d'), P('/a/d.gz'))
582 self.assertEqual(P('a/Dot ending.').with_stem('d'), P('a/d'))
583 self.assertEqual(P('/a/Dot ending.').with_stem('d'), P('/a/d'))
584 self.assertRaises(ValueError, P('').with_stem, 'd')
585 self.assertRaises(ValueError, P('.').with_stem, 'd')
586 self.assertRaises(ValueError, P('/').with_stem, 'd')
587 self.assertRaises(ValueError, P('a/b').with_stem, '')
588 self.assertRaises(ValueError, P('a/b').with_stem, '/c')
589 self.assertRaises(ValueError, P('a/b').with_stem, 'c/')
590 self.assertRaises(ValueError, P('a/b').with_stem, 'c/d')
591
Antoine Pitrou31119e42013-11-22 17:38:12 +0100592 def test_with_suffix_common(self):
593 P = self.cls
594 self.assertEqual(P('a/b').with_suffix('.gz'), P('a/b.gz'))
595 self.assertEqual(P('/a/b').with_suffix('.gz'), P('/a/b.gz'))
596 self.assertEqual(P('a/b.py').with_suffix('.gz'), P('a/b.gz'))
597 self.assertEqual(P('/a/b.py').with_suffix('.gz'), P('/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100598 # Stripping suffix.
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400599 self.assertEqual(P('a/b.py').with_suffix(''), P('a/b'))
600 self.assertEqual(P('/a/b').with_suffix(''), P('/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100601 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100602 self.assertRaises(ValueError, P('').with_suffix, '.gz')
603 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
604 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +1100605 # Invalid suffix.
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100606 self.assertRaises(ValueError, P('a/b').with_suffix, 'gz')
607 self.assertRaises(ValueError, P('a/b').with_suffix, '/')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400608 self.assertRaises(ValueError, P('a/b').with_suffix, '.')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100609 self.assertRaises(ValueError, P('a/b').with_suffix, '/.gz')
610 self.assertRaises(ValueError, P('a/b').with_suffix, 'c/d')
611 self.assertRaises(ValueError, P('a/b').with_suffix, '.c/.d')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400612 self.assertRaises(ValueError, P('a/b').with_suffix, './.d')
613 self.assertRaises(ValueError, P('a/b').with_suffix, '.d/.')
Berker Peksag423d05f2018-08-11 08:45:06 +0300614 self.assertRaises(ValueError, P('a/b').with_suffix,
615 (self.flavour.sep, 'd'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100616
617 def test_relative_to_common(self):
618 P = self.cls
619 p = P('a/b')
620 self.assertRaises(TypeError, p.relative_to)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100621 self.assertRaises(TypeError, p.relative_to, b'a')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100622 self.assertEqual(p.relative_to(P()), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100623 self.assertEqual(p.relative_to(''), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100624 self.assertEqual(p.relative_to(P('a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100625 self.assertEqual(p.relative_to('a'), P('b'))
626 self.assertEqual(p.relative_to('a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100627 self.assertEqual(p.relative_to(P('a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100628 self.assertEqual(p.relative_to('a/b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100629 # With several args.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100630 self.assertEqual(p.relative_to('a', 'b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100631 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100632 self.assertRaises(ValueError, p.relative_to, P('c'))
633 self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
634 self.assertRaises(ValueError, p.relative_to, P('a/c'))
635 self.assertRaises(ValueError, p.relative_to, P('/a'))
636 p = P('/a/b')
637 self.assertEqual(p.relative_to(P('/')), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100638 self.assertEqual(p.relative_to('/'), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100639 self.assertEqual(p.relative_to(P('/a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100640 self.assertEqual(p.relative_to('/a'), P('b'))
641 self.assertEqual(p.relative_to('/a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100642 self.assertEqual(p.relative_to(P('/a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100643 self.assertEqual(p.relative_to('/a/b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100644 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100645 self.assertRaises(ValueError, p.relative_to, P('/c'))
646 self.assertRaises(ValueError, p.relative_to, P('/a/b/c'))
647 self.assertRaises(ValueError, p.relative_to, P('/a/c'))
648 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100649 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100650 self.assertRaises(ValueError, p.relative_to, P('a'))
651
Hai Shi82642a02019-08-13 14:54:02 -0500652 def test_is_relative_to_common(self):
653 P = self.cls
654 p = P('a/b')
655 self.assertRaises(TypeError, p.is_relative_to)
656 self.assertRaises(TypeError, p.is_relative_to, b'a')
657 self.assertTrue(p.is_relative_to(P()))
658 self.assertTrue(p.is_relative_to(''))
659 self.assertTrue(p.is_relative_to(P('a')))
660 self.assertTrue(p.is_relative_to('a/'))
661 self.assertTrue(p.is_relative_to(P('a/b')))
662 self.assertTrue(p.is_relative_to('a/b'))
663 # With several args.
664 self.assertTrue(p.is_relative_to('a', 'b'))
665 # Unrelated paths.
666 self.assertFalse(p.is_relative_to(P('c')))
667 self.assertFalse(p.is_relative_to(P('a/b/c')))
668 self.assertFalse(p.is_relative_to(P('a/c')))
669 self.assertFalse(p.is_relative_to(P('/a')))
670 p = P('/a/b')
671 self.assertTrue(p.is_relative_to(P('/')))
672 self.assertTrue(p.is_relative_to('/'))
673 self.assertTrue(p.is_relative_to(P('/a')))
674 self.assertTrue(p.is_relative_to('/a'))
675 self.assertTrue(p.is_relative_to('/a/'))
676 self.assertTrue(p.is_relative_to(P('/a/b')))
677 self.assertTrue(p.is_relative_to('/a/b'))
678 # Unrelated paths.
679 self.assertFalse(p.is_relative_to(P('/c')))
680 self.assertFalse(p.is_relative_to(P('/a/b/c')))
681 self.assertFalse(p.is_relative_to(P('/a/c')))
682 self.assertFalse(p.is_relative_to(P()))
683 self.assertFalse(p.is_relative_to(''))
684 self.assertFalse(p.is_relative_to(P('a')))
685
Antoine Pitrou31119e42013-11-22 17:38:12 +0100686 def test_pickling_common(self):
687 P = self.cls
688 p = P('/a/b')
689 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
690 dumped = pickle.dumps(p, proto)
691 pp = pickle.loads(dumped)
692 self.assertIs(pp.__class__, p.__class__)
693 self.assertEqual(pp, p)
694 self.assertEqual(hash(pp), hash(p))
695 self.assertEqual(str(pp), str(p))
696
697
698class PurePosixPathTest(_BasePurePathTest, unittest.TestCase):
699 cls = pathlib.PurePosixPath
700
701 def test_root(self):
702 P = self.cls
703 self.assertEqual(P('/a/b').root, '/')
704 self.assertEqual(P('///a/b').root, '/')
Anthony Shaw83da9262019-01-07 07:31:29 +1100705 # POSIX special case for two leading slashes.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100706 self.assertEqual(P('//a/b').root, '//')
707
708 def test_eq(self):
709 P = self.cls
710 self.assertNotEqual(P('a/b'), P('A/b'))
711 self.assertEqual(P('/a'), P('///a'))
712 self.assertNotEqual(P('/a'), P('//a'))
713
714 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100715 P = self.cls
716 self.assertEqual(P('/').as_uri(), 'file:///')
717 self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')
718 self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')
Antoine Pitrou29eac422013-11-22 17:57:03 +0100719
720 def test_as_uri_non_ascii(self):
721 from urllib.parse import quote_from_bytes
722 P = self.cls
723 try:
724 os.fsencode('\xe9')
725 except UnicodeEncodeError:
726 self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")
Antoine Pitrou31119e42013-11-22 17:38:12 +0100727 self.assertEqual(P('/a/b\xe9').as_uri(),
728 'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))
729
730 def test_match(self):
731 P = self.cls
732 self.assertFalse(P('A.py').match('a.PY'))
733
734 def test_is_absolute(self):
735 P = self.cls
736 self.assertFalse(P().is_absolute())
737 self.assertFalse(P('a').is_absolute())
738 self.assertFalse(P('a/b/').is_absolute())
739 self.assertTrue(P('/').is_absolute())
740 self.assertTrue(P('/a').is_absolute())
741 self.assertTrue(P('/a/b/').is_absolute())
742 self.assertTrue(P('//a').is_absolute())
743 self.assertTrue(P('//a/b').is_absolute())
744
745 def test_is_reserved(self):
746 P = self.cls
747 self.assertIs(False, P('').is_reserved())
748 self.assertIs(False, P('/').is_reserved())
749 self.assertIs(False, P('/foo/bar').is_reserved())
750 self.assertIs(False, P('/dev/con/PRN/NUL').is_reserved())
751
752 def test_join(self):
753 P = self.cls
754 p = P('//a')
755 pp = p.joinpath('b')
756 self.assertEqual(pp, P('//a/b'))
757 pp = P('/a').joinpath('//c')
758 self.assertEqual(pp, P('//c'))
759 pp = P('//a').joinpath('/c')
760 self.assertEqual(pp, P('/c'))
761
762 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100763 # Basically the same as joinpath().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100764 P = self.cls
765 p = P('//a')
766 pp = p / 'b'
767 self.assertEqual(pp, P('//a/b'))
768 pp = P('/a') / '//c'
769 self.assertEqual(pp, P('//c'))
770 pp = P('//a') / '/c'
771 self.assertEqual(pp, P('/c'))
772
773
774class PureWindowsPathTest(_BasePurePathTest, unittest.TestCase):
775 cls = pathlib.PureWindowsPath
776
777 equivalences = _BasePurePathTest.equivalences.copy()
778 equivalences.update({
779 'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('/', 'c:', 'a') ],
780 'c:/a': [
781 ('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),
782 ('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),
783 ],
784 '//a/b/': [ ('//a/b',) ],
785 '//a/b/c': [
786 ('//a/b', 'c'), ('//a/b/', 'c'),
787 ],
788 })
789
790 def test_str(self):
791 p = self.cls('a/b/c')
792 self.assertEqual(str(p), 'a\\b\\c')
793 p = self.cls('c:/a/b/c')
794 self.assertEqual(str(p), 'c:\\a\\b\\c')
795 p = self.cls('//a/b')
796 self.assertEqual(str(p), '\\\\a\\b\\')
797 p = self.cls('//a/b/c')
798 self.assertEqual(str(p), '\\\\a\\b\\c')
799 p = self.cls('//a/b/c/d')
800 self.assertEqual(str(p), '\\\\a\\b\\c\\d')
801
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200802 def test_str_subclass(self):
803 self._check_str_subclass('c:')
804 self._check_str_subclass('c:a')
805 self._check_str_subclass('c:a\\b.txt')
806 self._check_str_subclass('c:\\')
807 self._check_str_subclass('c:\\a')
808 self._check_str_subclass('c:\\a\\b.txt')
809 self._check_str_subclass('\\\\some\\share')
810 self._check_str_subclass('\\\\some\\share\\a')
811 self._check_str_subclass('\\\\some\\share\\a\\b.txt')
812
Antoine Pitrou31119e42013-11-22 17:38:12 +0100813 def test_eq(self):
814 P = self.cls
815 self.assertEqual(P('c:a/b'), P('c:a/b'))
816 self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))
817 self.assertNotEqual(P('c:a/b'), P('d:a/b'))
818 self.assertNotEqual(P('c:a/b'), P('c:/a/b'))
819 self.assertNotEqual(P('/a/b'), P('c:/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100820 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100821 self.assertEqual(P('a/B'), P('A/b'))
822 self.assertEqual(P('C:a/B'), P('c:A/b'))
823 self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))
824
825 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100826 P = self.cls
827 with self.assertRaises(ValueError):
828 P('/a/b').as_uri()
829 with self.assertRaises(ValueError):
830 P('c:a/b').as_uri()
831 self.assertEqual(P('c:/').as_uri(), 'file:///c:/')
832 self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')
833 self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')
834 self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')
835 self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')
836 self.assertEqual(P('//some/share/a/b.c').as_uri(),
837 'file://some/share/a/b.c')
838 self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),
839 'file://some/share/a/b%25%23c%C3%A9')
840
841 def test_match_common(self):
842 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +1100843 # Absolute patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100844 self.assertTrue(P('c:/b.py').match('/*.py'))
845 self.assertTrue(P('c:/b.py').match('c:*.py'))
846 self.assertTrue(P('c:/b.py').match('c:/*.py'))
847 self.assertFalse(P('d:/b.py').match('c:/*.py')) # wrong drive
848 self.assertFalse(P('b.py').match('/*.py'))
849 self.assertFalse(P('b.py').match('c:*.py'))
850 self.assertFalse(P('b.py').match('c:/*.py'))
851 self.assertFalse(P('c:b.py').match('/*.py'))
852 self.assertFalse(P('c:b.py').match('c:/*.py'))
853 self.assertFalse(P('/b.py').match('c:*.py'))
854 self.assertFalse(P('/b.py').match('c:/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100855 # UNC patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100856 self.assertTrue(P('//some/share/a.py').match('/*.py'))
857 self.assertTrue(P('//some/share/a.py').match('//some/share/*.py'))
858 self.assertFalse(P('//other/share/a.py').match('//some/share/*.py'))
859 self.assertFalse(P('//some/share/a/b.py').match('//some/share/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100860 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100861 self.assertTrue(P('B.py').match('b.PY'))
862 self.assertTrue(P('c:/a/B.Py').match('C:/A/*.pY'))
863 self.assertTrue(P('//Some/Share/B.Py').match('//somE/sharE/*.pY'))
864
865 def test_ordering_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100866 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100867 def assertOrderedEqual(a, b):
868 self.assertLessEqual(a, b)
869 self.assertGreaterEqual(b, a)
870 P = self.cls
871 p = P('c:A/b')
872 q = P('C:a/B')
873 assertOrderedEqual(p, q)
874 self.assertFalse(p < q)
875 self.assertFalse(p > q)
876 p = P('//some/Share/A/b')
877 q = P('//Some/SHARE/a/B')
878 assertOrderedEqual(p, q)
879 self.assertFalse(p < q)
880 self.assertFalse(p > q)
881
882 def test_parts(self):
883 P = self.cls
884 p = P('c:a/b')
885 parts = p.parts
886 self.assertEqual(parts, ('c:', 'a', 'b'))
887 p = P('c:/a/b')
888 parts = p.parts
889 self.assertEqual(parts, ('c:\\', 'a', 'b'))
890 p = P('//a/b/c/d')
891 parts = p.parts
892 self.assertEqual(parts, ('\\\\a\\b\\', 'c', 'd'))
893
894 def test_parent(self):
895 # Anchored
896 P = self.cls
897 p = P('z:a/b/c')
898 self.assertEqual(p.parent, P('z:a/b'))
899 self.assertEqual(p.parent.parent, P('z:a'))
900 self.assertEqual(p.parent.parent.parent, P('z:'))
901 self.assertEqual(p.parent.parent.parent.parent, P('z:'))
902 p = P('z:/a/b/c')
903 self.assertEqual(p.parent, P('z:/a/b'))
904 self.assertEqual(p.parent.parent, P('z:/a'))
905 self.assertEqual(p.parent.parent.parent, P('z:/'))
906 self.assertEqual(p.parent.parent.parent.parent, P('z:/'))
907 p = P('//a/b/c/d')
908 self.assertEqual(p.parent, P('//a/b/c'))
909 self.assertEqual(p.parent.parent, P('//a/b'))
910 self.assertEqual(p.parent.parent.parent, P('//a/b'))
911
912 def test_parents(self):
913 # Anchored
914 P = self.cls
915 p = P('z:a/b/')
916 par = p.parents
917 self.assertEqual(len(par), 2)
918 self.assertEqual(par[0], P('z:a'))
919 self.assertEqual(par[1], P('z:'))
Joshua Cannon45205842020-11-20 09:40:39 -0600920 self.assertEqual(par[0:1], (P('z:a'),))
921 self.assertEqual(par[:-1], (P('z:a'),))
922 self.assertEqual(par[:2], (P('z:a'), P('z:')))
923 self.assertEqual(par[1:], (P('z:'),))
924 self.assertEqual(par[::2], (P('z:a'),))
925 self.assertEqual(par[::-1], (P('z:'), P('z:a')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100926 self.assertEqual(list(par), [P('z:a'), P('z:')])
927 with self.assertRaises(IndexError):
928 par[2]
929 p = P('z:/a/b/')
930 par = p.parents
931 self.assertEqual(len(par), 2)
932 self.assertEqual(par[0], P('z:/a'))
933 self.assertEqual(par[1], P('z:/'))
Joshua Cannon45205842020-11-20 09:40:39 -0600934 self.assertEqual(par[0:1], (P('z:/a'),))
935 self.assertEqual(par[0:-1], (P('z:/a'),))
936 self.assertEqual(par[:2], (P('z:/a'), P('z:/')))
937 self.assertEqual(par[1:], (P('z:/'),))
938 self.assertEqual(par[::2], (P('z:/a'),))
939 self.assertEqual(par[::-1], (P('z:/'), P('z:/a'),))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100940 self.assertEqual(list(par), [P('z:/a'), P('z:/')])
941 with self.assertRaises(IndexError):
942 par[2]
943 p = P('//a/b/c/d')
944 par = p.parents
945 self.assertEqual(len(par), 2)
946 self.assertEqual(par[0], P('//a/b/c'))
947 self.assertEqual(par[1], P('//a/b'))
Joshua Cannon45205842020-11-20 09:40:39 -0600948 self.assertEqual(par[0:1], (P('//a/b/c'),))
949 self.assertEqual(par[0:-1], (P('//a/b/c'),))
950 self.assertEqual(par[:2], (P('//a/b/c'), P('//a/b')))
951 self.assertEqual(par[1:], (P('//a/b'),))
952 self.assertEqual(par[::2], (P('//a/b/c'),))
953 self.assertEqual(par[::-1], (P('//a/b'), P('//a/b/c')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100954 self.assertEqual(list(par), [P('//a/b/c'), P('//a/b')])
955 with self.assertRaises(IndexError):
956 par[2]
957
958 def test_drive(self):
959 P = self.cls
960 self.assertEqual(P('c:').drive, 'c:')
961 self.assertEqual(P('c:a/b').drive, 'c:')
962 self.assertEqual(P('c:/').drive, 'c:')
963 self.assertEqual(P('c:/a/b/').drive, 'c:')
964 self.assertEqual(P('//a/b').drive, '\\\\a\\b')
965 self.assertEqual(P('//a/b/').drive, '\\\\a\\b')
966 self.assertEqual(P('//a/b/c/d').drive, '\\\\a\\b')
967
968 def test_root(self):
969 P = self.cls
970 self.assertEqual(P('c:').root, '')
971 self.assertEqual(P('c:a/b').root, '')
972 self.assertEqual(P('c:/').root, '\\')
973 self.assertEqual(P('c:/a/b/').root, '\\')
974 self.assertEqual(P('//a/b').root, '\\')
975 self.assertEqual(P('//a/b/').root, '\\')
976 self.assertEqual(P('//a/b/c/d').root, '\\')
977
978 def test_anchor(self):
979 P = self.cls
980 self.assertEqual(P('c:').anchor, 'c:')
981 self.assertEqual(P('c:a/b').anchor, 'c:')
982 self.assertEqual(P('c:/').anchor, 'c:\\')
983 self.assertEqual(P('c:/a/b/').anchor, 'c:\\')
984 self.assertEqual(P('//a/b').anchor, '\\\\a\\b\\')
985 self.assertEqual(P('//a/b/').anchor, '\\\\a\\b\\')
986 self.assertEqual(P('//a/b/c/d').anchor, '\\\\a\\b\\')
987
988 def test_name(self):
989 P = self.cls
990 self.assertEqual(P('c:').name, '')
991 self.assertEqual(P('c:/').name, '')
992 self.assertEqual(P('c:a/b').name, 'b')
993 self.assertEqual(P('c:/a/b').name, 'b')
994 self.assertEqual(P('c:a/b.py').name, 'b.py')
995 self.assertEqual(P('c:/a/b.py').name, 'b.py')
996 self.assertEqual(P('//My.py/Share.php').name, '')
997 self.assertEqual(P('//My.py/Share.php/a/b').name, 'b')
998
999 def test_suffix(self):
1000 P = self.cls
1001 self.assertEqual(P('c:').suffix, '')
1002 self.assertEqual(P('c:/').suffix, '')
1003 self.assertEqual(P('c:a/b').suffix, '')
1004 self.assertEqual(P('c:/a/b').suffix, '')
1005 self.assertEqual(P('c:a/b.py').suffix, '.py')
1006 self.assertEqual(P('c:/a/b.py').suffix, '.py')
1007 self.assertEqual(P('c:a/.hgrc').suffix, '')
1008 self.assertEqual(P('c:/a/.hgrc').suffix, '')
1009 self.assertEqual(P('c:a/.hg.rc').suffix, '.rc')
1010 self.assertEqual(P('c:/a/.hg.rc').suffix, '.rc')
1011 self.assertEqual(P('c:a/b.tar.gz').suffix, '.gz')
1012 self.assertEqual(P('c:/a/b.tar.gz').suffix, '.gz')
1013 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffix, '')
1014 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffix, '')
1015 self.assertEqual(P('//My.py/Share.php').suffix, '')
1016 self.assertEqual(P('//My.py/Share.php/a/b').suffix, '')
1017
1018 def test_suffixes(self):
1019 P = self.cls
1020 self.assertEqual(P('c:').suffixes, [])
1021 self.assertEqual(P('c:/').suffixes, [])
1022 self.assertEqual(P('c:a/b').suffixes, [])
1023 self.assertEqual(P('c:/a/b').suffixes, [])
1024 self.assertEqual(P('c:a/b.py').suffixes, ['.py'])
1025 self.assertEqual(P('c:/a/b.py').suffixes, ['.py'])
1026 self.assertEqual(P('c:a/.hgrc').suffixes, [])
1027 self.assertEqual(P('c:/a/.hgrc').suffixes, [])
1028 self.assertEqual(P('c:a/.hg.rc').suffixes, ['.rc'])
1029 self.assertEqual(P('c:/a/.hg.rc').suffixes, ['.rc'])
1030 self.assertEqual(P('c:a/b.tar.gz').suffixes, ['.tar', '.gz'])
1031 self.assertEqual(P('c:/a/b.tar.gz').suffixes, ['.tar', '.gz'])
1032 self.assertEqual(P('//My.py/Share.php').suffixes, [])
1033 self.assertEqual(P('//My.py/Share.php/a/b').suffixes, [])
1034 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffixes, [])
1035 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffixes, [])
1036
1037 def test_stem(self):
1038 P = self.cls
1039 self.assertEqual(P('c:').stem, '')
1040 self.assertEqual(P('c:.').stem, '')
1041 self.assertEqual(P('c:..').stem, '..')
1042 self.assertEqual(P('c:/').stem, '')
1043 self.assertEqual(P('c:a/b').stem, 'b')
1044 self.assertEqual(P('c:a/b.py').stem, 'b')
1045 self.assertEqual(P('c:a/.hgrc').stem, '.hgrc')
1046 self.assertEqual(P('c:a/.hg.rc').stem, '.hg')
1047 self.assertEqual(P('c:a/b.tar.gz').stem, 'b.tar')
1048 self.assertEqual(P('c:a/Some name. Ending with a dot.').stem,
1049 'Some name. Ending with a dot.')
1050
1051 def test_with_name(self):
1052 P = self.cls
1053 self.assertEqual(P('c:a/b').with_name('d.xml'), P('c:a/d.xml'))
1054 self.assertEqual(P('c:/a/b').with_name('d.xml'), P('c:/a/d.xml'))
1055 self.assertEqual(P('c:a/Dot ending.').with_name('d.xml'), P('c:a/d.xml'))
1056 self.assertEqual(P('c:/a/Dot ending.').with_name('d.xml'), P('c:/a/d.xml'))
1057 self.assertRaises(ValueError, P('c:').with_name, 'd.xml')
1058 self.assertRaises(ValueError, P('c:/').with_name, 'd.xml')
1059 self.assertRaises(ValueError, P('//My/Share').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -04001060 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:')
1061 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:e')
1062 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:/e')
1063 self.assertRaises(ValueError, P('c:a/b').with_name, '//My/Share')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001064
Tim Hoffmann8aea4b32020-04-19 17:29:49 +02001065 def test_with_stem(self):
1066 P = self.cls
1067 self.assertEqual(P('c:a/b').with_stem('d'), P('c:a/d'))
1068 self.assertEqual(P('c:/a/b').with_stem('d'), P('c:/a/d'))
1069 self.assertEqual(P('c:a/Dot ending.').with_stem('d'), P('c:a/d'))
1070 self.assertEqual(P('c:/a/Dot ending.').with_stem('d'), P('c:/a/d'))
1071 self.assertRaises(ValueError, P('c:').with_stem, 'd')
1072 self.assertRaises(ValueError, P('c:/').with_stem, 'd')
1073 self.assertRaises(ValueError, P('//My/Share').with_stem, 'd')
1074 self.assertRaises(ValueError, P('c:a/b').with_stem, 'd:')
1075 self.assertRaises(ValueError, P('c:a/b').with_stem, 'd:e')
1076 self.assertRaises(ValueError, P('c:a/b').with_stem, 'd:/e')
1077 self.assertRaises(ValueError, P('c:a/b').with_stem, '//My/Share')
1078
Antoine Pitrou31119e42013-11-22 17:38:12 +01001079 def test_with_suffix(self):
1080 P = self.cls
1081 self.assertEqual(P('c:a/b').with_suffix('.gz'), P('c:a/b.gz'))
1082 self.assertEqual(P('c:/a/b').with_suffix('.gz'), P('c:/a/b.gz'))
1083 self.assertEqual(P('c:a/b.py').with_suffix('.gz'), P('c:a/b.gz'))
1084 self.assertEqual(P('c:/a/b.py').with_suffix('.gz'), P('c:/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001085 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001086 self.assertRaises(ValueError, P('').with_suffix, '.gz')
1087 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
1088 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
1089 self.assertRaises(ValueError, P('//My/Share').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +11001090 # Invalid suffix.
Antoine Pitrou1b02da92014-01-03 00:07:17 +01001091 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'gz')
1092 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/')
1093 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\')
1094 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:')
1095 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/.gz')
1096 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\.gz')
1097 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:.gz')
1098 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c/d')
1099 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c\\d')
1100 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c/d')
1101 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c\\d')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001102
1103 def test_relative_to(self):
1104 P = self.cls
Antoine Pitrou156b3612013-12-28 19:49:04 +01001105 p = P('C:Foo/Bar')
1106 self.assertEqual(p.relative_to(P('c:')), P('Foo/Bar'))
1107 self.assertEqual(p.relative_to('c:'), P('Foo/Bar'))
1108 self.assertEqual(p.relative_to(P('c:foO')), P('Bar'))
1109 self.assertEqual(p.relative_to('c:foO'), P('Bar'))
1110 self.assertEqual(p.relative_to('c:foO/'), P('Bar'))
1111 self.assertEqual(p.relative_to(P('c:foO/baR')), P())
1112 self.assertEqual(p.relative_to('c:foO/baR'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001113 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001114 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +01001115 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001116 self.assertRaises(ValueError, p.relative_to, P('d:'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001117 self.assertRaises(ValueError, p.relative_to, P('/'))
1118 self.assertRaises(ValueError, p.relative_to, P('Foo'))
1119 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1120 self.assertRaises(ValueError, p.relative_to, P('C:/Foo'))
1121 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Bar/Baz'))
1122 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Baz'))
1123 p = P('C:/Foo/Bar')
1124 self.assertEqual(p.relative_to(P('c:')), P('/Foo/Bar'))
1125 self.assertEqual(p.relative_to('c:'), P('/Foo/Bar'))
1126 self.assertEqual(str(p.relative_to(P('c:'))), '\\Foo\\Bar')
1127 self.assertEqual(str(p.relative_to('c:')), '\\Foo\\Bar')
1128 self.assertEqual(p.relative_to(P('c:/')), P('Foo/Bar'))
1129 self.assertEqual(p.relative_to('c:/'), P('Foo/Bar'))
1130 self.assertEqual(p.relative_to(P('c:/foO')), P('Bar'))
1131 self.assertEqual(p.relative_to('c:/foO'), P('Bar'))
1132 self.assertEqual(p.relative_to('c:/foO/'), P('Bar'))
1133 self.assertEqual(p.relative_to(P('c:/foO/baR')), P())
1134 self.assertEqual(p.relative_to('c:/foO/baR'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001135 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001136 self.assertRaises(ValueError, p.relative_to, P('C:/Baz'))
1137 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Bar/Baz'))
1138 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Baz'))
1139 self.assertRaises(ValueError, p.relative_to, P('C:Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001140 self.assertRaises(ValueError, p.relative_to, P('d:'))
1141 self.assertRaises(ValueError, p.relative_to, P('d:/'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001142 self.assertRaises(ValueError, p.relative_to, P('/'))
1143 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1144 self.assertRaises(ValueError, p.relative_to, P('//C/Foo'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001145 # UNC paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001146 p = P('//Server/Share/Foo/Bar')
1147 self.assertEqual(p.relative_to(P('//sErver/sHare')), P('Foo/Bar'))
1148 self.assertEqual(p.relative_to('//sErver/sHare'), P('Foo/Bar'))
1149 self.assertEqual(p.relative_to('//sErver/sHare/'), P('Foo/Bar'))
1150 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo')), P('Bar'))
1151 self.assertEqual(p.relative_to('//sErver/sHare/Foo'), P('Bar'))
1152 self.assertEqual(p.relative_to('//sErver/sHare/Foo/'), P('Bar'))
1153 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo/Bar')), P())
1154 self.assertEqual(p.relative_to('//sErver/sHare/Foo/Bar'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001155 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001156 self.assertRaises(ValueError, p.relative_to, P('/Server/Share/Foo'))
1157 self.assertRaises(ValueError, p.relative_to, P('c:/Server/Share/Foo'))
1158 self.assertRaises(ValueError, p.relative_to, P('//z/Share/Foo'))
1159 self.assertRaises(ValueError, p.relative_to, P('//Server/z/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001160
Hai Shi82642a02019-08-13 14:54:02 -05001161 def test_is_relative_to(self):
1162 P = self.cls
1163 p = P('C:Foo/Bar')
1164 self.assertTrue(p.is_relative_to(P('c:')))
1165 self.assertTrue(p.is_relative_to('c:'))
1166 self.assertTrue(p.is_relative_to(P('c:foO')))
1167 self.assertTrue(p.is_relative_to('c:foO'))
1168 self.assertTrue(p.is_relative_to('c:foO/'))
1169 self.assertTrue(p.is_relative_to(P('c:foO/baR')))
1170 self.assertTrue(p.is_relative_to('c:foO/baR'))
1171 # Unrelated paths.
1172 self.assertFalse(p.is_relative_to(P()))
1173 self.assertFalse(p.is_relative_to(''))
1174 self.assertFalse(p.is_relative_to(P('d:')))
1175 self.assertFalse(p.is_relative_to(P('/')))
1176 self.assertFalse(p.is_relative_to(P('Foo')))
1177 self.assertFalse(p.is_relative_to(P('/Foo')))
1178 self.assertFalse(p.is_relative_to(P('C:/Foo')))
1179 self.assertFalse(p.is_relative_to(P('C:Foo/Bar/Baz')))
1180 self.assertFalse(p.is_relative_to(P('C:Foo/Baz')))
1181 p = P('C:/Foo/Bar')
1182 self.assertTrue(p.is_relative_to('c:'))
1183 self.assertTrue(p.is_relative_to(P('c:/')))
1184 self.assertTrue(p.is_relative_to(P('c:/foO')))
1185 self.assertTrue(p.is_relative_to('c:/foO/'))
1186 self.assertTrue(p.is_relative_to(P('c:/foO/baR')))
1187 self.assertTrue(p.is_relative_to('c:/foO/baR'))
1188 # Unrelated paths.
1189 self.assertFalse(p.is_relative_to(P('C:/Baz')))
1190 self.assertFalse(p.is_relative_to(P('C:/Foo/Bar/Baz')))
1191 self.assertFalse(p.is_relative_to(P('C:/Foo/Baz')))
1192 self.assertFalse(p.is_relative_to(P('C:Foo')))
1193 self.assertFalse(p.is_relative_to(P('d:')))
1194 self.assertFalse(p.is_relative_to(P('d:/')))
1195 self.assertFalse(p.is_relative_to(P('/')))
1196 self.assertFalse(p.is_relative_to(P('/Foo')))
1197 self.assertFalse(p.is_relative_to(P('//C/Foo')))
1198 # UNC paths.
1199 p = P('//Server/Share/Foo/Bar')
1200 self.assertTrue(p.is_relative_to(P('//sErver/sHare')))
1201 self.assertTrue(p.is_relative_to('//sErver/sHare'))
1202 self.assertTrue(p.is_relative_to('//sErver/sHare/'))
1203 self.assertTrue(p.is_relative_to(P('//sErver/sHare/Foo')))
1204 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo'))
1205 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo/'))
1206 self.assertTrue(p.is_relative_to(P('//sErver/sHare/Foo/Bar')))
1207 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo/Bar'))
1208 # Unrelated paths.
1209 self.assertFalse(p.is_relative_to(P('/Server/Share/Foo')))
1210 self.assertFalse(p.is_relative_to(P('c:/Server/Share/Foo')))
1211 self.assertFalse(p.is_relative_to(P('//z/Share/Foo')))
1212 self.assertFalse(p.is_relative_to(P('//Server/z/Foo')))
1213
Antoine Pitrou31119e42013-11-22 17:38:12 +01001214 def test_is_absolute(self):
1215 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +11001216 # Under NT, only paths with both a drive and a root are absolute.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001217 self.assertFalse(P().is_absolute())
1218 self.assertFalse(P('a').is_absolute())
1219 self.assertFalse(P('a/b/').is_absolute())
1220 self.assertFalse(P('/').is_absolute())
1221 self.assertFalse(P('/a').is_absolute())
1222 self.assertFalse(P('/a/b/').is_absolute())
1223 self.assertFalse(P('c:').is_absolute())
1224 self.assertFalse(P('c:a').is_absolute())
1225 self.assertFalse(P('c:a/b/').is_absolute())
1226 self.assertTrue(P('c:/').is_absolute())
1227 self.assertTrue(P('c:/a').is_absolute())
1228 self.assertTrue(P('c:/a/b/').is_absolute())
Anthony Shaw83da9262019-01-07 07:31:29 +11001229 # UNC paths are absolute by definition.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001230 self.assertTrue(P('//a/b').is_absolute())
1231 self.assertTrue(P('//a/b/').is_absolute())
1232 self.assertTrue(P('//a/b/c').is_absolute())
1233 self.assertTrue(P('//a/b/c/d').is_absolute())
1234
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001235 def test_join(self):
1236 P = self.cls
1237 p = P('C:/a/b')
1238 pp = p.joinpath('x/y')
1239 self.assertEqual(pp, P('C:/a/b/x/y'))
1240 pp = p.joinpath('/x/y')
1241 self.assertEqual(pp, P('C:/x/y'))
1242 # Joining with a different drive => the first path is ignored, even
1243 # if the second path is relative.
1244 pp = p.joinpath('D:x/y')
1245 self.assertEqual(pp, P('D:x/y'))
1246 pp = p.joinpath('D:/x/y')
1247 self.assertEqual(pp, P('D:/x/y'))
1248 pp = p.joinpath('//host/share/x/y')
1249 self.assertEqual(pp, P('//host/share/x/y'))
1250 # Joining with the same drive => the first path is appended to if
1251 # the second path is relative.
1252 pp = p.joinpath('c:x/y')
1253 self.assertEqual(pp, P('C:/a/b/x/y'))
1254 pp = p.joinpath('c:/x/y')
1255 self.assertEqual(pp, P('C:/x/y'))
1256
1257 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001258 # Basically the same as joinpath().
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001259 P = self.cls
1260 p = P('C:/a/b')
1261 self.assertEqual(p / 'x/y', P('C:/a/b/x/y'))
1262 self.assertEqual(p / 'x' / 'y', P('C:/a/b/x/y'))
1263 self.assertEqual(p / '/x/y', P('C:/x/y'))
1264 self.assertEqual(p / '/x' / 'y', P('C:/x/y'))
1265 # Joining with a different drive => the first path is ignored, even
1266 # if the second path is relative.
1267 self.assertEqual(p / 'D:x/y', P('D:x/y'))
1268 self.assertEqual(p / 'D:' / 'x/y', P('D:x/y'))
1269 self.assertEqual(p / 'D:/x/y', P('D:/x/y'))
1270 self.assertEqual(p / 'D:' / '/x/y', P('D:/x/y'))
1271 self.assertEqual(p / '//host/share/x/y', P('//host/share/x/y'))
1272 # Joining with the same drive => the first path is appended to if
1273 # the second path is relative.
Serhiy Storchaka010ff582013-12-06 17:25:51 +02001274 self.assertEqual(p / 'c:x/y', P('C:/a/b/x/y'))
1275 self.assertEqual(p / 'c:/x/y', P('C:/x/y'))
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001276
Antoine Pitrou31119e42013-11-22 17:38:12 +01001277 def test_is_reserved(self):
1278 P = self.cls
1279 self.assertIs(False, P('').is_reserved())
1280 self.assertIs(False, P('/').is_reserved())
1281 self.assertIs(False, P('/foo/bar').is_reserved())
1282 self.assertIs(True, P('con').is_reserved())
1283 self.assertIs(True, P('NUL').is_reserved())
1284 self.assertIs(True, P('NUL.txt').is_reserved())
1285 self.assertIs(True, P('com1').is_reserved())
1286 self.assertIs(True, P('com9.bar').is_reserved())
1287 self.assertIs(False, P('bar.com9').is_reserved())
1288 self.assertIs(True, P('lpt1').is_reserved())
1289 self.assertIs(True, P('lpt9.bar').is_reserved())
1290 self.assertIs(False, P('bar.lpt9').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001291 # Only the last component matters.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001292 self.assertIs(False, P('c:/NUL/con/baz').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001293 # UNC paths are never reserved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001294 self.assertIs(False, P('//my/share/nul/con/aux').is_reserved())
1295
Antoine Pitrou31119e42013-11-22 17:38:12 +01001296class PurePathTest(_BasePurePathTest, unittest.TestCase):
1297 cls = pathlib.PurePath
1298
1299 def test_concrete_class(self):
1300 p = self.cls('a')
1301 self.assertIs(type(p),
1302 pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath)
1303
1304 def test_different_flavours_unequal(self):
1305 p = pathlib.PurePosixPath('a')
1306 q = pathlib.PureWindowsPath('a')
1307 self.assertNotEqual(p, q)
1308
1309 def test_different_flavours_unordered(self):
1310 p = pathlib.PurePosixPath('a')
1311 q = pathlib.PureWindowsPath('a')
1312 with self.assertRaises(TypeError):
1313 p < q
1314 with self.assertRaises(TypeError):
1315 p <= q
1316 with self.assertRaises(TypeError):
1317 p > q
1318 with self.assertRaises(TypeError):
1319 p >= q
1320
1321
1322#
Anthony Shaw83da9262019-01-07 07:31:29 +11001323# Tests for the concrete classes.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001324#
1325
Anthony Shaw83da9262019-01-07 07:31:29 +11001326# Make sure any symbolic links in the base test path are resolved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001327BASE = os.path.realpath(TESTFN)
1328join = lambda *x: os.path.join(BASE, *x)
1329rel_join = lambda *x: os.path.join(TESTFN, *x)
1330
Antoine Pitrou31119e42013-11-22 17:38:12 +01001331only_nt = unittest.skipIf(os.name != 'nt',
1332 'test requires a Windows-compatible system')
1333only_posix = unittest.skipIf(os.name == 'nt',
1334 'test requires a POSIX-compatible system')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001335
1336@only_posix
1337class PosixPathAsPureTest(PurePosixPathTest):
1338 cls = pathlib.PosixPath
1339
1340@only_nt
1341class WindowsPathAsPureTest(PureWindowsPathTest):
1342 cls = pathlib.WindowsPath
1343
Victor Stinnerd7569632016-03-11 22:53:00 +01001344 def test_owner(self):
1345 P = self.cls
1346 with self.assertRaises(NotImplementedError):
1347 P('c:/').owner()
1348
1349 def test_group(self):
1350 P = self.cls
1351 with self.assertRaises(NotImplementedError):
1352 P('c:/').group()
1353
Antoine Pitrou31119e42013-11-22 17:38:12 +01001354
1355class _BasePathTest(object):
1356 """Tests for the FS-accessing functionalities of the Path classes."""
1357
1358 # (BASE)
1359 # |
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001360 # |-- brokenLink -> non-existing
1361 # |-- dirA
1362 # | `-- linkC -> ../dirB
1363 # |-- dirB
1364 # | |-- fileB
1365 # | `-- linkD -> ../dirB
1366 # |-- dirC
1367 # | |-- dirD
1368 # | | `-- fileD
1369 # | `-- fileC
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001370 # |-- dirE # No permissions
Antoine Pitrou31119e42013-11-22 17:38:12 +01001371 # |-- fileA
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001372 # |-- linkA -> fileA
Jörg Stucked5c120f2019-05-21 19:44:40 +02001373 # |-- linkB -> dirB
1374 # `-- brokenLinkLoop -> brokenLinkLoop
Antoine Pitrou31119e42013-11-22 17:38:12 +01001375 #
1376
1377 def setUp(self):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001378 def cleanup():
1379 os.chmod(join('dirE'), 0o777)
Hai Shibb0424b2020-08-04 00:47:42 +08001380 os_helper.rmtree(BASE)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001381 self.addCleanup(cleanup)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001382 os.mkdir(BASE)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001383 os.mkdir(join('dirA'))
1384 os.mkdir(join('dirB'))
1385 os.mkdir(join('dirC'))
1386 os.mkdir(join('dirC', 'dirD'))
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001387 os.mkdir(join('dirE'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001388 with open(join('fileA'), 'wb') as f:
1389 f.write(b"this is file A\n")
1390 with open(join('dirB', 'fileB'), 'wb') as f:
1391 f.write(b"this is file B\n")
1392 with open(join('dirC', 'fileC'), 'wb') as f:
1393 f.write(b"this is file C\n")
1394 with open(join('dirC', 'dirD', 'fileD'), 'wb') as f:
1395 f.write(b"this is file D\n")
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001396 os.chmod(join('dirE'), 0)
Hai Shibb0424b2020-08-04 00:47:42 +08001397 if os_helper.can_symlink():
Anthony Shaw83da9262019-01-07 07:31:29 +11001398 # Relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001399 os.symlink('fileA', join('linkA'))
1400 os.symlink('non-existing', join('brokenLink'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001401 self.dirlink('dirB', join('linkB'))
1402 self.dirlink(os.path.join('..', 'dirB'), join('dirA', 'linkC'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001403 # This one goes upwards, creating a loop.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001404 self.dirlink(os.path.join('..', 'dirB'), join('dirB', 'linkD'))
Jörg Stucked5c120f2019-05-21 19:44:40 +02001405 # Broken symlink (pointing to itself).
1406 os.symlink('brokenLinkLoop', join('brokenLinkLoop'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001407
1408 if os.name == 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11001409 # Workaround for http://bugs.python.org/issue13772.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001410 def dirlink(self, src, dest):
1411 os.symlink(src, dest, target_is_directory=True)
1412 else:
1413 def dirlink(self, src, dest):
1414 os.symlink(src, dest)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001415
1416 def assertSame(self, path_a, path_b):
1417 self.assertTrue(os.path.samefile(str(path_a), str(path_b)),
1418 "%r and %r don't point to the same file" %
1419 (path_a, path_b))
1420
1421 def assertFileNotFound(self, func, *args, **kwargs):
1422 with self.assertRaises(FileNotFoundError) as cm:
1423 func(*args, **kwargs)
1424 self.assertEqual(cm.exception.errno, errno.ENOENT)
1425
Steve Dower97d79062019-09-10 14:52:48 +01001426 def assertEqualNormCase(self, path_a, path_b):
1427 self.assertEqual(os.path.normcase(path_a), os.path.normcase(path_b))
1428
Antoine Pitrou31119e42013-11-22 17:38:12 +01001429 def _test_cwd(self, p):
1430 q = self.cls(os.getcwd())
1431 self.assertEqual(p, q)
Steve Dower97d79062019-09-10 14:52:48 +01001432 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001433 self.assertIs(type(p), type(q))
1434 self.assertTrue(p.is_absolute())
1435
1436 def test_cwd(self):
1437 p = self.cls.cwd()
1438 self._test_cwd(p)
1439
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001440 def _test_home(self, p):
1441 q = self.cls(os.path.expanduser('~'))
1442 self.assertEqual(p, q)
Steve Dower97d79062019-09-10 14:52:48 +01001443 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001444 self.assertIs(type(p), type(q))
1445 self.assertTrue(p.is_absolute())
1446
1447 def test_home(self):
Hai Shibb0424b2020-08-04 00:47:42 +08001448 with os_helper.EnvironmentVarGuard() as env:
Christoph Reiterc45a2aa2020-01-28 10:41:50 +01001449 self._test_home(self.cls.home())
1450
1451 env.clear()
1452 env['USERPROFILE'] = os.path.join(BASE, 'userprofile')
1453 self._test_home(self.cls.home())
1454
1455 # bpo-38883: ignore `HOME` when set on windows
1456 env['HOME'] = os.path.join(BASE, 'home')
1457 self._test_home(self.cls.home())
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001458
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001459 def test_samefile(self):
1460 fileA_path = os.path.join(BASE, 'fileA')
1461 fileB_path = os.path.join(BASE, 'dirB', 'fileB')
1462 p = self.cls(fileA_path)
1463 pp = self.cls(fileA_path)
1464 q = self.cls(fileB_path)
1465 self.assertTrue(p.samefile(fileA_path))
1466 self.assertTrue(p.samefile(pp))
1467 self.assertFalse(p.samefile(fileB_path))
1468 self.assertFalse(p.samefile(q))
1469 # Test the non-existent file case
1470 non_existent = os.path.join(BASE, 'foo')
1471 r = self.cls(non_existent)
1472 self.assertRaises(FileNotFoundError, p.samefile, r)
1473 self.assertRaises(FileNotFoundError, p.samefile, non_existent)
1474 self.assertRaises(FileNotFoundError, r.samefile, p)
1475 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1476 self.assertRaises(FileNotFoundError, r.samefile, r)
1477 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1478
Antoine Pitrou31119e42013-11-22 17:38:12 +01001479 def test_empty_path(self):
1480 # The empty path points to '.'
1481 p = self.cls('')
1482 self.assertEqual(p.stat(), os.stat('.'))
1483
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001484 def test_expanduser_common(self):
1485 P = self.cls
1486 p = P('~')
1487 self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))
1488 p = P('foo')
1489 self.assertEqual(p.expanduser(), p)
1490 p = P('/~')
1491 self.assertEqual(p.expanduser(), p)
1492 p = P('../~')
1493 self.assertEqual(p.expanduser(), p)
1494 p = P(P('').absolute().anchor) / '~'
1495 self.assertEqual(p.expanduser(), p)
1496
Antoine Pitrou31119e42013-11-22 17:38:12 +01001497 def test_exists(self):
1498 P = self.cls
1499 p = P(BASE)
1500 self.assertIs(True, p.exists())
1501 self.assertIs(True, (p / 'dirA').exists())
1502 self.assertIs(True, (p / 'fileA').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001503 self.assertIs(False, (p / 'fileA' / 'bah').exists())
Hai Shibb0424b2020-08-04 00:47:42 +08001504 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001505 self.assertIs(True, (p / 'linkA').exists())
1506 self.assertIs(True, (p / 'linkB').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001507 self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1508 self.assertIs(False, (p / 'linkA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001509 self.assertIs(False, (p / 'foo').exists())
1510 self.assertIs(False, P('/xyzzy').exists())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001511 self.assertIs(False, P(BASE + '\udfff').exists())
1512 self.assertIs(False, P(BASE + '\x00').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001513
1514 def test_open_common(self):
1515 p = self.cls(BASE)
1516 with (p / 'fileA').open('r') as f:
1517 self.assertIsInstance(f, io.TextIOBase)
1518 self.assertEqual(f.read(), "this is file A\n")
1519 with (p / 'fileA').open('rb') as f:
1520 self.assertIsInstance(f, io.BufferedIOBase)
1521 self.assertEqual(f.read().strip(), b"this is file A")
1522 with (p / 'fileA').open('rb', buffering=0) as f:
1523 self.assertIsInstance(f, io.RawIOBase)
1524 self.assertEqual(f.read().strip(), b"this is file A")
1525
Georg Brandlea683982014-10-01 19:12:33 +02001526 def test_read_write_bytes(self):
1527 p = self.cls(BASE)
1528 (p / 'fileA').write_bytes(b'abcdefg')
1529 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001530 # Check that trying to write str does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001531 self.assertRaises(TypeError, (p / 'fileA').write_bytes, 'somestr')
1532 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1533
1534 def test_read_write_text(self):
1535 p = self.cls(BASE)
1536 (p / 'fileA').write_text('äbcdefg', encoding='latin-1')
1537 self.assertEqual((p / 'fileA').read_text(
1538 encoding='utf-8', errors='ignore'), 'bcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001539 # Check that trying to write bytes does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001540 self.assertRaises(TypeError, (p / 'fileA').write_text, b'somebytes')
1541 self.assertEqual((p / 'fileA').read_text(encoding='latin-1'), 'äbcdefg')
1542
Максим5f227412020-10-21 05:08:19 +03001543 def test_write_text_with_newlines(self):
1544 p = self.cls(BASE)
1545 # Check that `\n` character change nothing
1546 (p / 'fileA').write_text('abcde\r\nfghlk\n\rmnopq', newline='\n')
1547 self.assertEqual((p / 'fileA').read_bytes(),
1548 b'abcde\r\nfghlk\n\rmnopq')
1549 # Check that `\r` character replaces `\n`
1550 (p / 'fileA').write_text('abcde\r\nfghlk\n\rmnopq', newline='\r')
1551 self.assertEqual((p / 'fileA').read_bytes(),
1552 b'abcde\r\rfghlk\r\rmnopq')
1553 # Check that `\r\n` character replaces `\n`
1554 (p / 'fileA').write_text('abcde\r\nfghlk\n\rmnopq', newline='\r\n')
1555 self.assertEqual((p / 'fileA').read_bytes(),
1556 b'abcde\r\r\nfghlk\r\n\rmnopq')
1557 # Check that no argument passed will change `\n` to `os.linesep`
1558 os_linesep_byte = bytes(os.linesep, encoding='ascii')
1559 (p / 'fileA').write_text('abcde\nfghlk\n\rmnopq')
1560 self.assertEqual((p / 'fileA').read_bytes(),
1561 b'abcde' + os_linesep_byte + b'fghlk' + os_linesep_byte + b'\rmnopq')
1562
Antoine Pitrou31119e42013-11-22 17:38:12 +01001563 def test_iterdir(self):
1564 P = self.cls
1565 p = P(BASE)
1566 it = p.iterdir()
1567 paths = set(it)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001568 expected = ['dirA', 'dirB', 'dirC', 'dirE', 'fileA']
Hai Shibb0424b2020-08-04 00:47:42 +08001569 if os_helper.can_symlink():
Jörg Stucked5c120f2019-05-21 19:44:40 +02001570 expected += ['linkA', 'linkB', 'brokenLink', 'brokenLinkLoop']
Antoine Pitrou31119e42013-11-22 17:38:12 +01001571 self.assertEqual(paths, { P(BASE, q) for q in expected })
1572
Hai Shibb0424b2020-08-04 00:47:42 +08001573 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001574 def test_iterdir_symlink(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001575 # __iter__ on a symlink to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001576 P = self.cls
1577 p = P(BASE, 'linkB')
1578 paths = set(p.iterdir())
1579 expected = { P(BASE, 'linkB', q) for q in ['fileB', 'linkD'] }
1580 self.assertEqual(paths, expected)
1581
1582 def test_iterdir_nodir(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001583 # __iter__ on something that is not a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001584 p = self.cls(BASE, 'fileA')
1585 with self.assertRaises(OSError) as cm:
1586 next(p.iterdir())
1587 # ENOENT or EINVAL under Windows, ENOTDIR otherwise
Anthony Shaw83da9262019-01-07 07:31:29 +11001588 # (see issue #12802).
Antoine Pitrou31119e42013-11-22 17:38:12 +01001589 self.assertIn(cm.exception.errno, (errno.ENOTDIR,
1590 errno.ENOENT, errno.EINVAL))
1591
1592 def test_glob_common(self):
1593 def _check(glob, expected):
1594 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1595 P = self.cls
1596 p = P(BASE)
1597 it = p.glob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001598 self.assertIsInstance(it, collections.abc.Iterator)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001599 _check(it, ["fileA"])
1600 _check(p.glob("fileB"), [])
1601 _check(p.glob("dir*/file*"), ["dirB/fileB", "dirC/fileC"])
Hai Shibb0424b2020-08-04 00:47:42 +08001602 if not os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001603 _check(p.glob("*A"), ['dirA', 'fileA'])
1604 else:
1605 _check(p.glob("*A"), ['dirA', 'fileA', 'linkA'])
Hai Shibb0424b2020-08-04 00:47:42 +08001606 if not os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001607 _check(p.glob("*B/*"), ['dirB/fileB'])
1608 else:
1609 _check(p.glob("*B/*"), ['dirB/fileB', 'dirB/linkD',
1610 'linkB/fileB', 'linkB/linkD'])
Hai Shibb0424b2020-08-04 00:47:42 +08001611 if not os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001612 _check(p.glob("*/fileB"), ['dirB/fileB'])
1613 else:
1614 _check(p.glob("*/fileB"), ['dirB/fileB', 'linkB/fileB'])
1615
1616 def test_rglob_common(self):
1617 def _check(glob, expected):
1618 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1619 P = self.cls
1620 p = P(BASE)
1621 it = p.rglob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001622 self.assertIsInstance(it, collections.abc.Iterator)
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001623 _check(it, ["fileA"])
1624 _check(p.rglob("fileB"), ["dirB/fileB"])
1625 _check(p.rglob("*/fileA"), [])
Hai Shibb0424b2020-08-04 00:47:42 +08001626 if not os_helper.can_symlink():
Guido van Rossum9c39b672016-01-07 13:12:34 -08001627 _check(p.rglob("*/fileB"), ["dirB/fileB"])
1628 else:
1629 _check(p.rglob("*/fileB"), ["dirB/fileB", "dirB/linkD/fileB",
1630 "linkB/fileB", "dirA/linkC/fileB"])
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001631 _check(p.rglob("file*"), ["fileA", "dirB/fileB",
1632 "dirC/fileC", "dirC/dirD/fileD"])
Antoine Pitrou31119e42013-11-22 17:38:12 +01001633 p = P(BASE, "dirC")
1634 _check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
1635 _check(p.rglob("*/*"), ["dirC/dirD/fileD"])
1636
Hai Shibb0424b2020-08-04 00:47:42 +08001637 @os_helper.skip_unless_symlink
Guido van Rossum69bfb152016-01-06 10:31:33 -08001638 def test_rglob_symlink_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001639 # Don't get fooled by symlink loops (Issue #26012).
Guido van Rossum69bfb152016-01-06 10:31:33 -08001640 P = self.cls
1641 p = P(BASE)
1642 given = set(p.rglob('*'))
1643 expect = {'brokenLink',
1644 'dirA', 'dirA/linkC',
1645 'dirB', 'dirB/fileB', 'dirB/linkD',
1646 'dirC', 'dirC/dirD', 'dirC/dirD/fileD', 'dirC/fileC',
1647 'dirE',
1648 'fileA',
1649 'linkA',
1650 'linkB',
Jörg Stucked5c120f2019-05-21 19:44:40 +02001651 'brokenLinkLoop',
Guido van Rossum69bfb152016-01-06 10:31:33 -08001652 }
1653 self.assertEqual(given, {p / x for x in expect})
1654
Serhiy Storchakaf9dc2ad2019-09-12 15:54:48 +03001655 def test_glob_many_open_files(self):
1656 depth = 30
1657 P = self.cls
1658 base = P(BASE) / 'deep'
1659 p = P(base, *(['d']*depth))
1660 p.mkdir(parents=True)
1661 pattern = '/'.join(['*'] * depth)
1662 iters = [base.glob(pattern) for j in range(100)]
1663 for it in iters:
1664 self.assertEqual(next(it), p)
1665 iters = [base.rglob('d') for j in range(100)]
1666 p = base
1667 for i in range(depth):
1668 p = p / 'd'
1669 for it in iters:
1670 self.assertEqual(next(it), p)
1671
Antoine Pitrou31119e42013-11-22 17:38:12 +01001672 def test_glob_dotdot(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001673 # ".." is not special in globs.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001674 P = self.cls
1675 p = P(BASE)
1676 self.assertEqual(set(p.glob("..")), { P(BASE, "..") })
1677 self.assertEqual(set(p.glob("dirA/../file*")), { P(BASE, "dirA/../fileA") })
1678 self.assertEqual(set(p.glob("../xyzzy")), set())
1679
Hai Shibb0424b2020-08-04 00:47:42 +08001680 @os_helper.skip_unless_symlink
Pablo Galindoeb7560a2020-03-07 17:53:20 +00001681 def test_glob_permissions(self):
1682 # See bpo-38894
1683 P = self.cls
1684 base = P(BASE) / 'permissions'
1685 base.mkdir()
1686
1687 file1 = base / "file1"
1688 file1.touch()
1689 file2 = base / "file2"
1690 file2.touch()
1691
1692 subdir = base / "subdir"
1693
1694 file3 = base / "file3"
1695 file3.symlink_to(subdir / "other")
1696
1697 # Patching is needed to avoid relying on the filesystem
1698 # to return the order of the files as the error will not
1699 # happen if the symlink is the last item.
1700
1701 with mock.patch("os.scandir") as scandir:
1702 scandir.return_value = sorted(os.scandir(base))
1703 self.assertEqual(len(set(base.glob("*"))), 3)
1704
1705 subdir.mkdir()
1706
1707 with mock.patch("os.scandir") as scandir:
1708 scandir.return_value = sorted(os.scandir(base))
1709 self.assertEqual(len(set(base.glob("*"))), 4)
1710
1711 subdir.chmod(000)
1712
1713 with mock.patch("os.scandir") as scandir:
1714 scandir.return_value = sorted(os.scandir(base))
1715 self.assertEqual(len(set(base.glob("*"))), 4)
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001716
Steve Dower98eb3602016-11-09 12:58:17 -08001717 def _check_resolve(self, p, expected, strict=True):
1718 q = p.resolve(strict)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001719 self.assertEqual(q, expected)
1720
Anthony Shaw83da9262019-01-07 07:31:29 +11001721 # This can be used to check both relative and absolute resolutions.
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001722 _check_resolve_relative = _check_resolve_absolute = _check_resolve
Antoine Pitrou31119e42013-11-22 17:38:12 +01001723
Hai Shibb0424b2020-08-04 00:47:42 +08001724 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001725 def test_resolve_common(self):
1726 P = self.cls
1727 p = P(BASE, 'foo')
1728 with self.assertRaises(OSError) as cm:
Steve Dower98eb3602016-11-09 12:58:17 -08001729 p.resolve(strict=True)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001730 self.assertEqual(cm.exception.errno, errno.ENOENT)
Steve Dower98eb3602016-11-09 12:58:17 -08001731 # Non-strict
Steve Dower97d79062019-09-10 14:52:48 +01001732 self.assertEqualNormCase(str(p.resolve(strict=False)),
1733 os.path.join(BASE, 'foo'))
Steve Dower98eb3602016-11-09 12:58:17 -08001734 p = P(BASE, 'foo', 'in', 'spam')
Steve Dower97d79062019-09-10 14:52:48 +01001735 self.assertEqualNormCase(str(p.resolve(strict=False)),
1736 os.path.join(BASE, 'foo', 'in', 'spam'))
Steve Dower98eb3602016-11-09 12:58:17 -08001737 p = P(BASE, '..', 'foo', 'in', 'spam')
Steve Dower97d79062019-09-10 14:52:48 +01001738 self.assertEqualNormCase(str(p.resolve(strict=False)),
1739 os.path.abspath(os.path.join('foo', 'in', 'spam')))
Anthony Shaw83da9262019-01-07 07:31:29 +11001740 # These are all relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001741 p = P(BASE, 'dirB', 'fileB')
1742 self._check_resolve_relative(p, p)
1743 p = P(BASE, 'linkA')
1744 self._check_resolve_relative(p, P(BASE, 'fileA'))
1745 p = P(BASE, 'dirA', 'linkC', 'fileB')
1746 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1747 p = P(BASE, 'dirB', 'linkD', 'fileB')
1748 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001749 # Non-strict
1750 p = P(BASE, 'dirA', 'linkC', 'fileB', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001751 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB', 'foo', 'in',
1752 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001753 p = P(BASE, 'dirA', 'linkC', '..', 'foo', 'in', 'spam')
1754 if os.name == 'nt':
1755 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1756 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001757 self._check_resolve_relative(p, P(BASE, 'dirA', 'foo', 'in',
1758 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001759 else:
1760 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1761 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001762 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Anthony Shaw83da9262019-01-07 07:31:29 +11001763 # Now create absolute symlinks.
Hai Shibb0424b2020-08-04 00:47:42 +08001764 d = os_helper._longpath(tempfile.mkdtemp(suffix='-dirD',
1765 dir=os.getcwd()))
1766 self.addCleanup(os_helper.rmtree, d)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001767 os.symlink(os.path.join(d), join('dirA', 'linkX'))
1768 os.symlink(join('dirB'), os.path.join(d, 'linkY'))
1769 p = P(BASE, 'dirA', 'linkX', 'linkY', 'fileB')
1770 self._check_resolve_absolute(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001771 # Non-strict
1772 p = P(BASE, 'dirA', 'linkX', 'linkY', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001773 self._check_resolve_relative(p, P(BASE, 'dirB', 'foo', 'in', 'spam'),
1774 False)
Steve Dower98eb3602016-11-09 12:58:17 -08001775 p = P(BASE, 'dirA', 'linkX', 'linkY', '..', 'foo', 'in', 'spam')
1776 if os.name == 'nt':
1777 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1778 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001779 self._check_resolve_relative(p, P(d, 'foo', 'in', 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001780 else:
1781 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1782 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001783 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001784
Hai Shibb0424b2020-08-04 00:47:42 +08001785 @os_helper.skip_unless_symlink
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001786 def test_resolve_dot(self):
1787 # See https://bitbucket.org/pitrou/pathlib/issue/9/pathresolve-fails-on-complex-symlinks
1788 p = self.cls(BASE)
1789 self.dirlink('.', join('0'))
Antoine Pitroucc157512013-12-03 17:13:13 +01001790 self.dirlink(os.path.join('0', '0'), join('1'))
1791 self.dirlink(os.path.join('1', '1'), join('2'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001792 q = p / '2'
Steve Dower98eb3602016-11-09 12:58:17 -08001793 self.assertEqual(q.resolve(strict=True), p)
1794 r = q / '3' / '4'
1795 self.assertRaises(FileNotFoundError, r.resolve, strict=True)
1796 # Non-strict
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001797 self.assertEqual(r.resolve(strict=False), p / '3' / '4')
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001798
Antoine Pitrou31119e42013-11-22 17:38:12 +01001799 def test_with(self):
1800 p = self.cls(BASE)
1801 it = p.iterdir()
1802 it2 = p.iterdir()
1803 next(it2)
1804 with p:
1805 pass
Barney Gale00002e62020-04-01 15:10:51 +01001806 # Using a path as a context manager is a no-op, thus the following
1807 # operations should still succeed after the context manage exits.
1808 next(it)
1809 next(it2)
1810 p.exists()
1811 p.resolve()
1812 p.absolute()
1813 with p:
1814 pass
Antoine Pitrou31119e42013-11-22 17:38:12 +01001815
1816 def test_chmod(self):
1817 p = self.cls(BASE) / 'fileA'
1818 mode = p.stat().st_mode
Anthony Shaw83da9262019-01-07 07:31:29 +11001819 # Clear writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001820 new_mode = mode & ~0o222
1821 p.chmod(new_mode)
1822 self.assertEqual(p.stat().st_mode, new_mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11001823 # Set writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001824 new_mode = mode | 0o222
1825 p.chmod(new_mode)
1826 self.assertEqual(p.stat().st_mode, new_mode)
1827
Anthony Shaw83da9262019-01-07 07:31:29 +11001828 # XXX also need a test for lchmod.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001829
1830 def test_stat(self):
1831 p = self.cls(BASE) / 'fileA'
1832 st = p.stat()
1833 self.assertEqual(p.stat(), st)
Anthony Shaw83da9262019-01-07 07:31:29 +11001834 # Change file mode by flipping write bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001835 p.chmod(st.st_mode ^ 0o222)
1836 self.addCleanup(p.chmod, st.st_mode)
1837 self.assertNotEqual(p.stat(), st)
1838
Hai Shibb0424b2020-08-04 00:47:42 +08001839 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001840 def test_lstat(self):
1841 p = self.cls(BASE)/ 'linkA'
1842 st = p.stat()
1843 self.assertNotEqual(st, p.lstat())
1844
1845 def test_lstat_nosymlink(self):
1846 p = self.cls(BASE) / 'fileA'
1847 st = p.stat()
1848 self.assertEqual(st, p.lstat())
1849
1850 @unittest.skipUnless(pwd, "the pwd module is needed for this test")
1851 def test_owner(self):
1852 p = self.cls(BASE) / 'fileA'
1853 uid = p.stat().st_uid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001854 try:
1855 name = pwd.getpwuid(uid).pw_name
1856 except KeyError:
1857 self.skipTest(
1858 "user %d doesn't have an entry in the system database" % uid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001859 self.assertEqual(name, p.owner())
1860
1861 @unittest.skipUnless(grp, "the grp module is needed for this test")
1862 def test_group(self):
1863 p = self.cls(BASE) / 'fileA'
1864 gid = p.stat().st_gid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001865 try:
1866 name = grp.getgrgid(gid).gr_name
1867 except KeyError:
1868 self.skipTest(
1869 "group %d doesn't have an entry in the system database" % gid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001870 self.assertEqual(name, p.group())
1871
1872 def test_unlink(self):
1873 p = self.cls(BASE) / 'fileA'
1874 p.unlink()
1875 self.assertFileNotFound(p.stat)
1876 self.assertFileNotFound(p.unlink)
1877
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001878 def test_unlink_missing_ok(self):
1879 p = self.cls(BASE) / 'fileAAA'
1880 self.assertFileNotFound(p.unlink)
1881 p.unlink(missing_ok=True)
1882
Antoine Pitrou31119e42013-11-22 17:38:12 +01001883 def test_rmdir(self):
1884 p = self.cls(BASE) / 'dirA'
1885 for q in p.iterdir():
1886 q.unlink()
1887 p.rmdir()
1888 self.assertFileNotFound(p.stat)
1889 self.assertFileNotFound(p.unlink)
1890
Toke Høiland-Jørgensen092435e2019-12-16 13:23:55 +01001891 @unittest.skipUnless(hasattr(os, "link"), "os.link() is not present")
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001892 def test_link_to(self):
1893 P = self.cls(BASE)
1894 p = P / 'fileA'
1895 size = p.stat().st_size
1896 # linking to another path.
1897 q = P / 'dirA' / 'fileAA'
1898 try:
1899 p.link_to(q)
1900 except PermissionError as e:
1901 self.skipTest('os.link(): %s' % e)
1902 self.assertEqual(q.stat().st_size, size)
1903 self.assertEqual(os.path.samefile(p, q), True)
1904 self.assertTrue(p.stat)
1905 # Linking to a str of a relative path.
1906 r = rel_join('fileAAA')
1907 q.link_to(r)
1908 self.assertEqual(os.stat(r).st_size, size)
1909 self.assertTrue(q.stat)
1910
Toke Høiland-Jørgensen092435e2019-12-16 13:23:55 +01001911 @unittest.skipIf(hasattr(os, "link"), "os.link() is present")
1912 def test_link_to_not_implemented(self):
1913 P = self.cls(BASE)
1914 p = P / 'fileA'
1915 # linking to another path.
1916 q = P / 'dirA' / 'fileAA'
1917 with self.assertRaises(NotImplementedError):
1918 p.link_to(q)
1919
Antoine Pitrou31119e42013-11-22 17:38:12 +01001920 def test_rename(self):
1921 P = self.cls(BASE)
1922 p = P / 'fileA'
1923 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11001924 # Renaming to another path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001925 q = P / 'dirA' / 'fileAA'
hui shang088a09a2019-09-11 21:26:49 +08001926 renamed_p = p.rename(q)
1927 self.assertEqual(renamed_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001928 self.assertEqual(q.stat().st_size, size)
1929 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11001930 # Renaming to a str of a relative path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001931 r = rel_join('fileAAA')
hui shang088a09a2019-09-11 21:26:49 +08001932 renamed_q = q.rename(r)
1933 self.assertEqual(renamed_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001934 self.assertEqual(os.stat(r).st_size, size)
1935 self.assertFileNotFound(q.stat)
1936
1937 def test_replace(self):
1938 P = self.cls(BASE)
1939 p = P / 'fileA'
1940 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11001941 # Replacing a non-existing path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001942 q = P / 'dirA' / 'fileAA'
hui shang088a09a2019-09-11 21:26:49 +08001943 replaced_p = p.replace(q)
1944 self.assertEqual(replaced_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001945 self.assertEqual(q.stat().st_size, size)
1946 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11001947 # Replacing another (existing) path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001948 r = rel_join('dirB', 'fileB')
hui shang088a09a2019-09-11 21:26:49 +08001949 replaced_q = q.replace(r)
1950 self.assertEqual(replaced_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001951 self.assertEqual(os.stat(r).st_size, size)
1952 self.assertFileNotFound(q.stat)
1953
Hai Shibb0424b2020-08-04 00:47:42 +08001954 @os_helper.skip_unless_symlink
Girtsa01ba332019-10-23 14:18:40 -07001955 def test_readlink(self):
1956 P = self.cls(BASE)
1957 self.assertEqual((P / 'linkA').readlink(), self.cls('fileA'))
1958 self.assertEqual((P / 'brokenLink').readlink(),
1959 self.cls('non-existing'))
1960 self.assertEqual((P / 'linkB').readlink(), self.cls('dirB'))
1961 with self.assertRaises(OSError):
1962 (P / 'fileA').readlink()
1963
Antoine Pitrou31119e42013-11-22 17:38:12 +01001964 def test_touch_common(self):
1965 P = self.cls(BASE)
1966 p = P / 'newfileA'
1967 self.assertFalse(p.exists())
1968 p.touch()
1969 self.assertTrue(p.exists())
Antoine Pitrou0f575642013-11-22 23:20:08 +01001970 st = p.stat()
1971 old_mtime = st.st_mtime
1972 old_mtime_ns = st.st_mtime_ns
Antoine Pitrou31119e42013-11-22 17:38:12 +01001973 # Rewind the mtime sufficiently far in the past to work around
1974 # filesystem-specific timestamp granularity.
1975 os.utime(str(p), (old_mtime - 10, old_mtime - 10))
Anthony Shaw83da9262019-01-07 07:31:29 +11001976 # The file mtime should be refreshed by calling touch() again.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001977 p.touch()
Antoine Pitrou0f575642013-11-22 23:20:08 +01001978 st = p.stat()
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001979 self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)
1980 self.assertGreaterEqual(st.st_mtime, old_mtime)
Anthony Shaw83da9262019-01-07 07:31:29 +11001981 # Now with exist_ok=False.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001982 p = P / 'newfileB'
1983 self.assertFalse(p.exists())
1984 p.touch(mode=0o700, exist_ok=False)
1985 self.assertTrue(p.exists())
1986 self.assertRaises(OSError, p.touch, exist_ok=False)
1987
Antoine Pitrou8b784932013-11-23 14:52:39 +01001988 def test_touch_nochange(self):
1989 P = self.cls(BASE)
1990 p = P / 'fileA'
1991 p.touch()
1992 with p.open('rb') as f:
1993 self.assertEqual(f.read().strip(), b"this is file A")
1994
Antoine Pitrou31119e42013-11-22 17:38:12 +01001995 def test_mkdir(self):
1996 P = self.cls(BASE)
1997 p = P / 'newdirA'
1998 self.assertFalse(p.exists())
1999 p.mkdir()
2000 self.assertTrue(p.exists())
2001 self.assertTrue(p.is_dir())
2002 with self.assertRaises(OSError) as cm:
2003 p.mkdir()
2004 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002005
2006 def test_mkdir_parents(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002007 # Creating a chain of directories.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002008 p = self.cls(BASE, 'newdirB', 'newdirC')
2009 self.assertFalse(p.exists())
2010 with self.assertRaises(OSError) as cm:
2011 p.mkdir()
2012 self.assertEqual(cm.exception.errno, errno.ENOENT)
2013 p.mkdir(parents=True)
2014 self.assertTrue(p.exists())
2015 self.assertTrue(p.is_dir())
2016 with self.assertRaises(OSError) as cm:
2017 p.mkdir(parents=True)
2018 self.assertEqual(cm.exception.errno, errno.EEXIST)
Anthony Shaw83da9262019-01-07 07:31:29 +11002019 # Test `mode` arg.
2020 mode = stat.S_IMODE(p.stat().st_mode) # Default mode.
Antoine Pitrou0048c982013-12-16 20:22:37 +01002021 p = self.cls(BASE, 'newdirD', 'newdirE')
2022 p.mkdir(0o555, parents=True)
2023 self.assertTrue(p.exists())
2024 self.assertTrue(p.is_dir())
2025 if os.name != 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11002026 # The directory's permissions follow the mode argument.
Gregory P. Smithb599c612014-01-20 01:10:33 -08002027 self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11002028 # The parent's permissions follow the default process settings.
Antoine Pitrou0048c982013-12-16 20:22:37 +01002029 self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002030
Barry Warsaw7c549c42014-08-05 11:28:12 -04002031 def test_mkdir_exist_ok(self):
2032 p = self.cls(BASE, 'dirB')
2033 st_ctime_first = p.stat().st_ctime
2034 self.assertTrue(p.exists())
2035 self.assertTrue(p.is_dir())
2036 with self.assertRaises(FileExistsError) as cm:
2037 p.mkdir()
2038 self.assertEqual(cm.exception.errno, errno.EEXIST)
2039 p.mkdir(exist_ok=True)
2040 self.assertTrue(p.exists())
2041 self.assertEqual(p.stat().st_ctime, st_ctime_first)
2042
2043 def test_mkdir_exist_ok_with_parent(self):
2044 p = self.cls(BASE, 'dirC')
2045 self.assertTrue(p.exists())
2046 with self.assertRaises(FileExistsError) as cm:
2047 p.mkdir()
2048 self.assertEqual(cm.exception.errno, errno.EEXIST)
2049 p = p / 'newdirC'
2050 p.mkdir(parents=True)
2051 st_ctime_first = p.stat().st_ctime
2052 self.assertTrue(p.exists())
2053 with self.assertRaises(FileExistsError) as cm:
2054 p.mkdir(parents=True)
2055 self.assertEqual(cm.exception.errno, errno.EEXIST)
2056 p.mkdir(parents=True, exist_ok=True)
2057 self.assertTrue(p.exists())
2058 self.assertEqual(p.stat().st_ctime, st_ctime_first)
2059
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02002060 def test_mkdir_exist_ok_root(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002061 # Issue #25803: A drive root could raise PermissionError on Windows.
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02002062 self.cls('/').resolve().mkdir(exist_ok=True)
2063 self.cls('/').resolve().mkdir(parents=True, exist_ok=True)
2064
Anthony Shaw83da9262019-01-07 07:31:29 +11002065 @only_nt # XXX: not sure how to test this on POSIX.
Steve Dowerd3c48532017-02-04 14:54:56 -08002066 def test_mkdir_with_unknown_drive(self):
2067 for d in 'ZYXWVUTSRQPONMLKJIHGFEDCBA':
2068 p = self.cls(d + ':\\')
2069 if not p.is_dir():
2070 break
2071 else:
2072 self.skipTest("cannot find a drive that doesn't exist")
2073 with self.assertRaises(OSError):
2074 (p / 'child' / 'path').mkdir(parents=True)
2075
Barry Warsaw7c549c42014-08-05 11:28:12 -04002076 def test_mkdir_with_child_file(self):
2077 p = self.cls(BASE, 'dirB', 'fileB')
2078 self.assertTrue(p.exists())
2079 # An exception is raised when the last path component is an existing
2080 # regular file, regardless of whether exist_ok is true or not.
2081 with self.assertRaises(FileExistsError) as cm:
2082 p.mkdir(parents=True)
2083 self.assertEqual(cm.exception.errno, errno.EEXIST)
2084 with self.assertRaises(FileExistsError) as cm:
2085 p.mkdir(parents=True, exist_ok=True)
2086 self.assertEqual(cm.exception.errno, errno.EEXIST)
2087
2088 def test_mkdir_no_parents_file(self):
2089 p = self.cls(BASE, 'fileA')
2090 self.assertTrue(p.exists())
2091 # An exception is raised when the last path component is an existing
2092 # regular file, regardless of whether exist_ok is true or not.
2093 with self.assertRaises(FileExistsError) as cm:
2094 p.mkdir()
2095 self.assertEqual(cm.exception.errno, errno.EEXIST)
2096 with self.assertRaises(FileExistsError) as cm:
2097 p.mkdir(exist_ok=True)
2098 self.assertEqual(cm.exception.errno, errno.EEXIST)
2099
Armin Rigo22a594a2017-04-13 20:08:15 +02002100 def test_mkdir_concurrent_parent_creation(self):
2101 for pattern_num in range(32):
2102 p = self.cls(BASE, 'dirCPC%d' % pattern_num)
2103 self.assertFalse(p.exists())
2104
2105 def my_mkdir(path, mode=0o777):
2106 path = str(path)
2107 # Emulate another process that would create the directory
2108 # just before we try to create it ourselves. We do it
2109 # in all possible pattern combinations, assuming that this
2110 # function is called at most 5 times (dirCPC/dir1/dir2,
2111 # dirCPC/dir1, dirCPC, dirCPC/dir1, dirCPC/dir1/dir2).
2112 if pattern.pop():
Anthony Shaw83da9262019-01-07 07:31:29 +11002113 os.mkdir(path, mode) # From another process.
Armin Rigo22a594a2017-04-13 20:08:15 +02002114 concurrently_created.add(path)
Anthony Shaw83da9262019-01-07 07:31:29 +11002115 os.mkdir(path, mode) # Our real call.
Armin Rigo22a594a2017-04-13 20:08:15 +02002116
2117 pattern = [bool(pattern_num & (1 << n)) for n in range(5)]
2118 concurrently_created = set()
2119 p12 = p / 'dir1' / 'dir2'
2120 try:
2121 with mock.patch("pathlib._normal_accessor.mkdir", my_mkdir):
2122 p12.mkdir(parents=True, exist_ok=False)
2123 except FileExistsError:
2124 self.assertIn(str(p12), concurrently_created)
2125 else:
2126 self.assertNotIn(str(p12), concurrently_created)
2127 self.assertTrue(p.exists())
2128
Hai Shibb0424b2020-08-04 00:47:42 +08002129 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01002130 def test_symlink_to(self):
2131 P = self.cls(BASE)
2132 target = P / 'fileA'
Anthony Shaw83da9262019-01-07 07:31:29 +11002133 # Symlinking a path target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002134 link = P / 'dirA' / 'linkAA'
2135 link.symlink_to(target)
2136 self.assertEqual(link.stat(), target.stat())
2137 self.assertNotEqual(link.lstat(), target.stat())
Anthony Shaw83da9262019-01-07 07:31:29 +11002138 # Symlinking a str target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002139 link = P / 'dirA' / 'linkAAA'
2140 link.symlink_to(str(target))
2141 self.assertEqual(link.stat(), target.stat())
2142 self.assertNotEqual(link.lstat(), target.stat())
2143 self.assertFalse(link.is_dir())
Anthony Shaw83da9262019-01-07 07:31:29 +11002144 # Symlinking to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002145 target = P / 'dirB'
2146 link = P / 'dirA' / 'linkAAAA'
2147 link.symlink_to(target, target_is_directory=True)
2148 self.assertEqual(link.stat(), target.stat())
2149 self.assertNotEqual(link.lstat(), target.stat())
2150 self.assertTrue(link.is_dir())
2151 self.assertTrue(list(link.iterdir()))
2152
2153 def test_is_dir(self):
2154 P = self.cls(BASE)
2155 self.assertTrue((P / 'dirA').is_dir())
2156 self.assertFalse((P / 'fileA').is_dir())
2157 self.assertFalse((P / 'non-existing').is_dir())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002158 self.assertFalse((P / 'fileA' / 'bah').is_dir())
Hai Shibb0424b2020-08-04 00:47:42 +08002159 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002160 self.assertFalse((P / 'linkA').is_dir())
2161 self.assertTrue((P / 'linkB').is_dir())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002162 self.assertFalse((P/ 'brokenLink').is_dir(), False)
2163 self.assertIs((P / 'dirA\udfff').is_dir(), False)
2164 self.assertIs((P / 'dirA\x00').is_dir(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002165
2166 def test_is_file(self):
2167 P = self.cls(BASE)
2168 self.assertTrue((P / 'fileA').is_file())
2169 self.assertFalse((P / 'dirA').is_file())
2170 self.assertFalse((P / 'non-existing').is_file())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002171 self.assertFalse((P / 'fileA' / 'bah').is_file())
Hai Shibb0424b2020-08-04 00:47:42 +08002172 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002173 self.assertTrue((P / 'linkA').is_file())
2174 self.assertFalse((P / 'linkB').is_file())
2175 self.assertFalse((P/ 'brokenLink').is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002176 self.assertIs((P / 'fileA\udfff').is_file(), False)
2177 self.assertIs((P / 'fileA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002178
Cooper Lees173ff4a2017-08-01 15:35:45 -07002179 @only_posix
2180 def test_is_mount(self):
2181 P = self.cls(BASE)
Anthony Shaw83da9262019-01-07 07:31:29 +11002182 R = self.cls('/') # TODO: Work out Windows.
Cooper Lees173ff4a2017-08-01 15:35:45 -07002183 self.assertFalse((P / 'fileA').is_mount())
2184 self.assertFalse((P / 'dirA').is_mount())
2185 self.assertFalse((P / 'non-existing').is_mount())
2186 self.assertFalse((P / 'fileA' / 'bah').is_mount())
2187 self.assertTrue(R.is_mount())
Hai Shibb0424b2020-08-04 00:47:42 +08002188 if os_helper.can_symlink():
Cooper Lees173ff4a2017-08-01 15:35:45 -07002189 self.assertFalse((P / 'linkA').is_mount())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002190 self.assertIs(self.cls('/\udfff').is_mount(), False)
2191 self.assertIs(self.cls('/\x00').is_mount(), False)
Cooper Lees173ff4a2017-08-01 15:35:45 -07002192
Antoine Pitrou31119e42013-11-22 17:38:12 +01002193 def test_is_symlink(self):
2194 P = self.cls(BASE)
2195 self.assertFalse((P / 'fileA').is_symlink())
2196 self.assertFalse((P / 'dirA').is_symlink())
2197 self.assertFalse((P / 'non-existing').is_symlink())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002198 self.assertFalse((P / 'fileA' / 'bah').is_symlink())
Hai Shibb0424b2020-08-04 00:47:42 +08002199 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002200 self.assertTrue((P / 'linkA').is_symlink())
2201 self.assertTrue((P / 'linkB').is_symlink())
2202 self.assertTrue((P/ 'brokenLink').is_symlink())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002203 self.assertIs((P / 'fileA\udfff').is_file(), False)
2204 self.assertIs((P / 'fileA\x00').is_file(), False)
Hai Shibb0424b2020-08-04 00:47:42 +08002205 if os_helper.can_symlink():
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002206 self.assertIs((P / 'linkA\udfff').is_file(), False)
2207 self.assertIs((P / 'linkA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002208
2209 def test_is_fifo_false(self):
2210 P = self.cls(BASE)
2211 self.assertFalse((P / 'fileA').is_fifo())
2212 self.assertFalse((P / 'dirA').is_fifo())
2213 self.assertFalse((P / 'non-existing').is_fifo())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002214 self.assertFalse((P / 'fileA' / 'bah').is_fifo())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002215 self.assertIs((P / 'fileA\udfff').is_fifo(), False)
2216 self.assertIs((P / 'fileA\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002217
2218 @unittest.skipUnless(hasattr(os, "mkfifo"), "os.mkfifo() required")
2219 def test_is_fifo_true(self):
2220 P = self.cls(BASE, 'myfifo')
xdegaye92c2ca72017-11-12 17:31:07 +01002221 try:
2222 os.mkfifo(str(P))
2223 except PermissionError as e:
2224 self.skipTest('os.mkfifo(): %s' % e)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002225 self.assertTrue(P.is_fifo())
2226 self.assertFalse(P.is_socket())
2227 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002228 self.assertIs(self.cls(BASE, 'myfifo\udfff').is_fifo(), False)
2229 self.assertIs(self.cls(BASE, 'myfifo\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002230
2231 def test_is_socket_false(self):
2232 P = self.cls(BASE)
2233 self.assertFalse((P / 'fileA').is_socket())
2234 self.assertFalse((P / 'dirA').is_socket())
2235 self.assertFalse((P / 'non-existing').is_socket())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002236 self.assertFalse((P / 'fileA' / 'bah').is_socket())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002237 self.assertIs((P / 'fileA\udfff').is_socket(), False)
2238 self.assertIs((P / 'fileA\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002239
2240 @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required")
2241 def test_is_socket_true(self):
2242 P = self.cls(BASE, 'mysock')
Antoine Pitrou330ce592013-11-22 18:05:06 +01002243 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002244 self.addCleanup(sock.close)
Antoine Pitrou330ce592013-11-22 18:05:06 +01002245 try:
2246 sock.bind(str(P))
2247 except OSError as e:
Xavier de Gayee88ed052016-12-14 11:52:28 +01002248 if (isinstance(e, PermissionError) or
2249 "AF_UNIX path too long" in str(e)):
Antoine Pitrou330ce592013-11-22 18:05:06 +01002250 self.skipTest("cannot bind Unix socket: " + str(e))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002251 self.assertTrue(P.is_socket())
2252 self.assertFalse(P.is_fifo())
2253 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002254 self.assertIs(self.cls(BASE, 'mysock\udfff').is_socket(), False)
2255 self.assertIs(self.cls(BASE, 'mysock\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002256
2257 def test_is_block_device_false(self):
2258 P = self.cls(BASE)
2259 self.assertFalse((P / 'fileA').is_block_device())
2260 self.assertFalse((P / 'dirA').is_block_device())
2261 self.assertFalse((P / 'non-existing').is_block_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002262 self.assertFalse((P / 'fileA' / 'bah').is_block_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002263 self.assertIs((P / 'fileA\udfff').is_block_device(), False)
2264 self.assertIs((P / 'fileA\x00').is_block_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002265
2266 def test_is_char_device_false(self):
2267 P = self.cls(BASE)
2268 self.assertFalse((P / 'fileA').is_char_device())
2269 self.assertFalse((P / 'dirA').is_char_device())
2270 self.assertFalse((P / 'non-existing').is_char_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002271 self.assertFalse((P / 'fileA' / 'bah').is_char_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002272 self.assertIs((P / 'fileA\udfff').is_char_device(), False)
2273 self.assertIs((P / 'fileA\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002274
2275 def test_is_char_device_true(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002276 # Under Unix, /dev/null should generally be a char device.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002277 P = self.cls('/dev/null')
2278 if not P.exists():
2279 self.skipTest("/dev/null required")
2280 self.assertTrue(P.is_char_device())
2281 self.assertFalse(P.is_block_device())
2282 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002283 self.assertIs(self.cls('/dev/null\udfff').is_char_device(), False)
2284 self.assertIs(self.cls('/dev/null\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002285
2286 def test_pickling_common(self):
2287 p = self.cls(BASE, 'fileA')
2288 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
2289 dumped = pickle.dumps(p, proto)
2290 pp = pickle.loads(dumped)
2291 self.assertEqual(pp.stat(), p.stat())
2292
2293 def test_parts_interning(self):
2294 P = self.cls
2295 p = P('/usr/bin/foo')
2296 q = P('/usr/local/bin')
2297 # 'usr'
2298 self.assertIs(p.parts[1], q.parts[1])
2299 # 'bin'
2300 self.assertIs(p.parts[2], q.parts[3])
2301
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002302 def _check_complex_symlinks(self, link0_target):
Anthony Shaw83da9262019-01-07 07:31:29 +11002303 # Test solving a non-looping chain of symlinks (issue #19887).
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002304 P = self.cls(BASE)
2305 self.dirlink(os.path.join('link0', 'link0'), join('link1'))
2306 self.dirlink(os.path.join('link1', 'link1'), join('link2'))
2307 self.dirlink(os.path.join('link2', 'link2'), join('link3'))
2308 self.dirlink(link0_target, join('link0'))
2309
Anthony Shaw83da9262019-01-07 07:31:29 +11002310 # Resolve absolute paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002311 p = (P / 'link0').resolve()
2312 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002313 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002314 p = (P / 'link1').resolve()
2315 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002316 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002317 p = (P / 'link2').resolve()
2318 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002319 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002320 p = (P / 'link3').resolve()
2321 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002322 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002323
Anthony Shaw83da9262019-01-07 07:31:29 +11002324 # Resolve relative paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002325 old_path = os.getcwd()
2326 os.chdir(BASE)
2327 try:
2328 p = self.cls('link0').resolve()
2329 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002330 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002331 p = self.cls('link1').resolve()
2332 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002333 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002334 p = self.cls('link2').resolve()
2335 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002336 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002337 p = self.cls('link3').resolve()
2338 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002339 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002340 finally:
2341 os.chdir(old_path)
2342
Hai Shibb0424b2020-08-04 00:47:42 +08002343 @os_helper.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002344 def test_complex_symlinks_absolute(self):
2345 self._check_complex_symlinks(BASE)
2346
Hai Shibb0424b2020-08-04 00:47:42 +08002347 @os_helper.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002348 def test_complex_symlinks_relative(self):
2349 self._check_complex_symlinks('.')
2350
Hai Shibb0424b2020-08-04 00:47:42 +08002351 @os_helper.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002352 def test_complex_symlinks_relative_dot_dot(self):
2353 self._check_complex_symlinks(os.path.join('dirA', '..'))
2354
Antoine Pitrou31119e42013-11-22 17:38:12 +01002355
2356class PathTest(_BasePathTest, unittest.TestCase):
2357 cls = pathlib.Path
2358
Batuhan Taşkaya526606b2019-12-08 23:31:15 +03002359 def test_class_getitem(self):
2360 self.assertIs(self.cls[str], self.cls)
2361
Antoine Pitrou31119e42013-11-22 17:38:12 +01002362 def test_concrete_class(self):
2363 p = self.cls('a')
2364 self.assertIs(type(p),
2365 pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath)
2366
2367 def test_unsupported_flavour(self):
2368 if os.name == 'nt':
2369 self.assertRaises(NotImplementedError, pathlib.PosixPath)
2370 else:
2371 self.assertRaises(NotImplementedError, pathlib.WindowsPath)
2372
Berker Peksag4a208e42016-01-30 17:50:48 +02002373 def test_glob_empty_pattern(self):
2374 p = self.cls()
2375 with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
2376 list(p.glob(''))
2377
Antoine Pitrou31119e42013-11-22 17:38:12 +01002378
2379@only_posix
2380class PosixPathTest(_BasePathTest, unittest.TestCase):
2381 cls = pathlib.PosixPath
2382
Steve Dower98eb3602016-11-09 12:58:17 -08002383 def _check_symlink_loop(self, *args, strict=True):
Antoine Pitrou31119e42013-11-22 17:38:12 +01002384 path = self.cls(*args)
2385 with self.assertRaises(RuntimeError):
Steve Dower98eb3602016-11-09 12:58:17 -08002386 print(path.resolve(strict))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002387
2388 def test_open_mode(self):
2389 old_mask = os.umask(0)
2390 self.addCleanup(os.umask, old_mask)
2391 p = self.cls(BASE)
2392 with (p / 'new_file').open('wb'):
2393 pass
2394 st = os.stat(join('new_file'))
2395 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2396 os.umask(0o022)
2397 with (p / 'other_new_file').open('wb'):
2398 pass
2399 st = os.stat(join('other_new_file'))
2400 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2401
Dong-hee Na94ad6c62018-06-12 23:30:45 +09002402 def test_resolve_root(self):
2403 current_directory = os.getcwd()
2404 try:
2405 os.chdir('/')
2406 p = self.cls('spam')
2407 self.assertEqual(str(p.resolve()), '/spam')
2408 finally:
2409 os.chdir(current_directory)
2410
Antoine Pitrou31119e42013-11-22 17:38:12 +01002411 def test_touch_mode(self):
2412 old_mask = os.umask(0)
2413 self.addCleanup(os.umask, old_mask)
2414 p = self.cls(BASE)
2415 (p / 'new_file').touch()
2416 st = os.stat(join('new_file'))
2417 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2418 os.umask(0o022)
2419 (p / 'other_new_file').touch()
2420 st = os.stat(join('other_new_file'))
2421 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2422 (p / 'masked_new_file').touch(mode=0o750)
2423 st = os.stat(join('masked_new_file'))
2424 self.assertEqual(stat.S_IMODE(st.st_mode), 0o750)
2425
Hai Shibb0424b2020-08-04 00:47:42 +08002426 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01002427 def test_resolve_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002428 # Loops with relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002429 os.symlink('linkX/inside', join('linkX'))
2430 self._check_symlink_loop(BASE, 'linkX')
2431 os.symlink('linkY', join('linkY'))
2432 self._check_symlink_loop(BASE, 'linkY')
2433 os.symlink('linkZ/../linkZ', join('linkZ'))
2434 self._check_symlink_loop(BASE, 'linkZ')
Steve Dower98eb3602016-11-09 12:58:17 -08002435 # Non-strict
2436 self._check_symlink_loop(BASE, 'linkZ', 'foo', strict=False)
Anthony Shaw83da9262019-01-07 07:31:29 +11002437 # Loops with absolute symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002438 os.symlink(join('linkU/inside'), join('linkU'))
2439 self._check_symlink_loop(BASE, 'linkU')
2440 os.symlink(join('linkV'), join('linkV'))
2441 self._check_symlink_loop(BASE, 'linkV')
2442 os.symlink(join('linkW/../linkW'), join('linkW'))
2443 self._check_symlink_loop(BASE, 'linkW')
Steve Dower98eb3602016-11-09 12:58:17 -08002444 # Non-strict
2445 self._check_symlink_loop(BASE, 'linkW', 'foo', strict=False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002446
2447 def test_glob(self):
2448 P = self.cls
2449 p = P(BASE)
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002450 given = set(p.glob("FILEa"))
Hai Shibb0424b2020-08-04 00:47:42 +08002451 expect = set() if not os_helper.fs_is_case_insensitive(BASE) else given
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002452 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002453 self.assertEqual(set(p.glob("FILEa*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002454
2455 def test_rglob(self):
2456 P = self.cls
2457 p = P(BASE, "dirC")
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002458 given = set(p.rglob("FILEd"))
Hai Shibb0424b2020-08-04 00:47:42 +08002459 expect = set() if not os_helper.fs_is_case_insensitive(BASE) else given
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002460 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002461 self.assertEqual(set(p.rglob("FILEd*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002462
Xavier de Gayefb24eea2016-12-13 09:11:38 +01002463 @unittest.skipUnless(hasattr(pwd, 'getpwall'),
2464 'pwd module does not expose getpwall()')
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002465 def test_expanduser(self):
2466 P = self.cls
Hai Shibb0424b2020-08-04 00:47:42 +08002467 import_helper.import_module('pwd')
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002468 import pwd
2469 pwdent = pwd.getpwuid(os.getuid())
2470 username = pwdent.pw_name
Serhiy Storchakaa3fd0b22016-05-03 21:17:03 +03002471 userhome = pwdent.pw_dir.rstrip('/') or '/'
Anthony Shaw83da9262019-01-07 07:31:29 +11002472 # Find arbitrary different user (if exists).
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002473 for pwdent in pwd.getpwall():
2474 othername = pwdent.pw_name
2475 otherhome = pwdent.pw_dir.rstrip('/')
Victor Stinnere9694392015-01-10 09:00:20 +01002476 if othername != username and otherhome:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002477 break
Anders Kaseorg5c0d4622018-05-14 10:00:37 -04002478 else:
2479 othername = username
2480 otherhome = userhome
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002481
2482 p1 = P('~/Documents')
2483 p2 = P('~' + username + '/Documents')
2484 p3 = P('~' + othername + '/Documents')
2485 p4 = P('../~' + username + '/Documents')
2486 p5 = P('/~' + username + '/Documents')
2487 p6 = P('')
2488 p7 = P('~fakeuser/Documents')
2489
Hai Shibb0424b2020-08-04 00:47:42 +08002490 with os_helper.EnvironmentVarGuard() as env:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002491 env.pop('HOME', None)
2492
2493 self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
2494 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2495 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2496 self.assertEqual(p4.expanduser(), p4)
2497 self.assertEqual(p5.expanduser(), p5)
2498 self.assertEqual(p6.expanduser(), p6)
2499 self.assertRaises(RuntimeError, p7.expanduser)
2500
2501 env['HOME'] = '/tmp'
2502 self.assertEqual(p1.expanduser(), P('/tmp/Documents'))
2503 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2504 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2505 self.assertEqual(p4.expanduser(), p4)
2506 self.assertEqual(p5.expanduser(), p5)
2507 self.assertEqual(p6.expanduser(), p6)
2508 self.assertRaises(RuntimeError, p7.expanduser)
2509
Przemysław Spodymek216b7452018-08-27 23:33:45 +02002510 @unittest.skipIf(sys.platform != "darwin",
2511 "Bad file descriptor in /dev/fd affects only macOS")
2512 def test_handling_bad_descriptor(self):
2513 try:
2514 file_descriptors = list(pathlib.Path('/dev/fd').rglob("*"))[3:]
2515 if not file_descriptors:
2516 self.skipTest("no file descriptors - issue was not reproduced")
2517 # Checking all file descriptors because there is no guarantee
2518 # which one will fail.
2519 for f in file_descriptors:
2520 f.exists()
2521 f.is_dir()
2522 f.is_file()
2523 f.is_symlink()
2524 f.is_block_device()
2525 f.is_char_device()
2526 f.is_fifo()
2527 f.is_socket()
2528 except OSError as e:
2529 if e.errno == errno.EBADF:
2530 self.fail("Bad file descriptor not handled.")
2531 raise
2532
Antoine Pitrou31119e42013-11-22 17:38:12 +01002533
2534@only_nt
2535class WindowsPathTest(_BasePathTest, unittest.TestCase):
2536 cls = pathlib.WindowsPath
2537
2538 def test_glob(self):
2539 P = self.cls
2540 p = P(BASE)
2541 self.assertEqual(set(p.glob("FILEa")), { P(BASE, "fileA") })
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +03002542 self.assertEqual(set(p.glob("F*a")), { P(BASE, "fileA") })
2543 self.assertEqual(set(map(str, p.glob("FILEa"))), {f"{p}\\FILEa"})
2544 self.assertEqual(set(map(str, p.glob("F*a"))), {f"{p}\\fileA"})
Antoine Pitrou31119e42013-11-22 17:38:12 +01002545
2546 def test_rglob(self):
2547 P = self.cls
2548 p = P(BASE, "dirC")
2549 self.assertEqual(set(p.rglob("FILEd")), { P(BASE, "dirC/dirD/fileD") })
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +03002550 self.assertEqual(set(map(str, p.rglob("FILEd"))), {f"{p}\\dirD\\FILEd"})
Antoine Pitrou31119e42013-11-22 17:38:12 +01002551
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002552 def test_expanduser(self):
2553 P = self.cls
Hai Shibb0424b2020-08-04 00:47:42 +08002554 with os_helper.EnvironmentVarGuard() as env:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002555 env.pop('HOME', None)
2556 env.pop('USERPROFILE', None)
2557 env.pop('HOMEPATH', None)
2558 env.pop('HOMEDRIVE', None)
2559 env['USERNAME'] = 'alice'
2560
2561 # test that the path returns unchanged
2562 p1 = P('~/My Documents')
2563 p2 = P('~alice/My Documents')
2564 p3 = P('~bob/My Documents')
2565 p4 = P('/~/My Documents')
2566 p5 = P('d:~/My Documents')
2567 p6 = P('')
2568 self.assertRaises(RuntimeError, p1.expanduser)
2569 self.assertRaises(RuntimeError, p2.expanduser)
2570 self.assertRaises(RuntimeError, p3.expanduser)
2571 self.assertEqual(p4.expanduser(), p4)
2572 self.assertEqual(p5.expanduser(), p5)
2573 self.assertEqual(p6.expanduser(), p6)
2574
2575 def check():
2576 env.pop('USERNAME', None)
2577 self.assertEqual(p1.expanduser(),
2578 P('C:/Users/alice/My Documents'))
2579 self.assertRaises(KeyError, p2.expanduser)
2580 env['USERNAME'] = 'alice'
2581 self.assertEqual(p2.expanduser(),
2582 P('C:/Users/alice/My Documents'))
2583 self.assertEqual(p3.expanduser(),
2584 P('C:/Users/bob/My Documents'))
2585 self.assertEqual(p4.expanduser(), p4)
2586 self.assertEqual(p5.expanduser(), p5)
2587 self.assertEqual(p6.expanduser(), p6)
2588
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002589 env['HOMEPATH'] = 'C:\\Users\\alice'
2590 check()
2591
2592 env['HOMEDRIVE'] = 'C:\\'
2593 env['HOMEPATH'] = 'Users\\alice'
2594 check()
2595
2596 env.pop('HOMEDRIVE', None)
2597 env.pop('HOMEPATH', None)
2598 env['USERPROFILE'] = 'C:\\Users\\alice'
2599 check()
2600
Christoph Reiterc45a2aa2020-01-28 10:41:50 +01002601 # bpo-38883: ignore `HOME` when set on windows
2602 env['HOME'] = 'C:\\Users\\eve'
2603 check()
2604
Antoine Pitrou31119e42013-11-22 17:38:12 +01002605
aiudirog4c69be22019-08-08 01:41:10 -04002606class CompatiblePathTest(unittest.TestCase):
2607 """
2608 Test that a type can be made compatible with PurePath
2609 derivatives by implementing division operator overloads.
2610 """
2611
2612 class CompatPath:
2613 """
2614 Minimum viable class to test PurePath compatibility.
2615 Simply uses the division operator to join a given
2616 string and the string value of another object with
2617 a forward slash.
2618 """
2619 def __init__(self, string):
2620 self.string = string
2621
2622 def __truediv__(self, other):
2623 return type(self)(f"{self.string}/{other}")
2624
2625 def __rtruediv__(self, other):
2626 return type(self)(f"{other}/{self.string}")
2627
2628 def test_truediv(self):
2629 result = pathlib.PurePath("test") / self.CompatPath("right")
2630 self.assertIsInstance(result, self.CompatPath)
2631 self.assertEqual(result.string, "test/right")
2632
2633 with self.assertRaises(TypeError):
2634 # Verify improper operations still raise a TypeError
2635 pathlib.PurePath("test") / 10
2636
2637 def test_rtruediv(self):
2638 result = self.CompatPath("left") / pathlib.PurePath("test")
2639 self.assertIsInstance(result, self.CompatPath)
2640 self.assertEqual(result.string, "left/test")
2641
2642 with self.assertRaises(TypeError):
2643 # Verify improper operations still raise a TypeError
2644 10 / pathlib.PurePath("test")
2645
2646
Antoine Pitrou31119e42013-11-22 17:38:12 +01002647if __name__ == "__main__":
2648 unittest.main()