blob: 54b7977b43f2351e9554e4476048c4e3b641540f [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('.'))
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200443 self.assertEqual(par[-1], P('.'))
444 self.assertEqual(par[-2], P('a'))
445 self.assertEqual(par[-3], P('a/b'))
Joshua Cannon45205842020-11-20 09:40:39 -0600446 self.assertEqual(par[0:1], (P('a/b'),))
447 self.assertEqual(par[:2], (P('a/b'), P('a')))
448 self.assertEqual(par[:-1], (P('a/b'), P('a')))
449 self.assertEqual(par[1:], (P('a'), P('.')))
450 self.assertEqual(par[::2], (P('a/b'), P('.')))
451 self.assertEqual(par[::-1], (P('.'), P('a'), P('a/b')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100452 self.assertEqual(list(par), [P('a/b'), P('a'), P('.')])
453 with self.assertRaises(IndexError):
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200454 par[-4]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100455 with self.assertRaises(IndexError):
456 par[3]
457 with self.assertRaises(TypeError):
458 par[0] = p
459 # Anchored
460 p = P('/a/b/c')
461 par = p.parents
462 self.assertEqual(len(par), 3)
463 self.assertEqual(par[0], P('/a/b'))
464 self.assertEqual(par[1], P('/a'))
465 self.assertEqual(par[2], P('/'))
Joshua Cannon45205842020-11-20 09:40:39 -0600466 self.assertEqual(par[0:1], (P('/a/b'),))
467 self.assertEqual(par[:2], (P('/a/b'), P('/a')))
468 self.assertEqual(par[:-1], (P('/a/b'), P('/a')))
469 self.assertEqual(par[1:], (P('/a'), P('/')))
470 self.assertEqual(par[::2], (P('/a/b'), P('/')))
471 self.assertEqual(par[::-1], (P('/'), P('/a'), P('/a/b')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100472 self.assertEqual(list(par), [P('/a/b'), P('/a'), P('/')])
473 with self.assertRaises(IndexError):
474 par[3]
475
476 def test_drive_common(self):
477 P = self.cls
478 self.assertEqual(P('a/b').drive, '')
479 self.assertEqual(P('/a/b').drive, '')
480 self.assertEqual(P('').drive, '')
481
482 def test_root_common(self):
483 P = self.cls
484 sep = self.sep
485 self.assertEqual(P('').root, '')
486 self.assertEqual(P('a/b').root, '')
487 self.assertEqual(P('/').root, sep)
488 self.assertEqual(P('/a/b').root, sep)
489
490 def test_anchor_common(self):
491 P = self.cls
492 sep = self.sep
493 self.assertEqual(P('').anchor, '')
494 self.assertEqual(P('a/b').anchor, '')
495 self.assertEqual(P('/').anchor, sep)
496 self.assertEqual(P('/a/b').anchor, sep)
497
498 def test_name_common(self):
499 P = self.cls
500 self.assertEqual(P('').name, '')
501 self.assertEqual(P('.').name, '')
502 self.assertEqual(P('/').name, '')
503 self.assertEqual(P('a/b').name, 'b')
504 self.assertEqual(P('/a/b').name, 'b')
505 self.assertEqual(P('/a/b/.').name, 'b')
506 self.assertEqual(P('a/b.py').name, 'b.py')
507 self.assertEqual(P('/a/b.py').name, 'b.py')
508
509 def test_suffix_common(self):
510 P = self.cls
511 self.assertEqual(P('').suffix, '')
512 self.assertEqual(P('.').suffix, '')
513 self.assertEqual(P('..').suffix, '')
514 self.assertEqual(P('/').suffix, '')
515 self.assertEqual(P('a/b').suffix, '')
516 self.assertEqual(P('/a/b').suffix, '')
517 self.assertEqual(P('/a/b/.').suffix, '')
518 self.assertEqual(P('a/b.py').suffix, '.py')
519 self.assertEqual(P('/a/b.py').suffix, '.py')
520 self.assertEqual(P('a/.hgrc').suffix, '')
521 self.assertEqual(P('/a/.hgrc').suffix, '')
522 self.assertEqual(P('a/.hg.rc').suffix, '.rc')
523 self.assertEqual(P('/a/.hg.rc').suffix, '.rc')
524 self.assertEqual(P('a/b.tar.gz').suffix, '.gz')
525 self.assertEqual(P('/a/b.tar.gz').suffix, '.gz')
526 self.assertEqual(P('a/Some name. Ending with a dot.').suffix, '')
527 self.assertEqual(P('/a/Some name. Ending with a dot.').suffix, '')
528
529 def test_suffixes_common(self):
530 P = self.cls
531 self.assertEqual(P('').suffixes, [])
532 self.assertEqual(P('.').suffixes, [])
533 self.assertEqual(P('/').suffixes, [])
534 self.assertEqual(P('a/b').suffixes, [])
535 self.assertEqual(P('/a/b').suffixes, [])
536 self.assertEqual(P('/a/b/.').suffixes, [])
537 self.assertEqual(P('a/b.py').suffixes, ['.py'])
538 self.assertEqual(P('/a/b.py').suffixes, ['.py'])
539 self.assertEqual(P('a/.hgrc').suffixes, [])
540 self.assertEqual(P('/a/.hgrc').suffixes, [])
541 self.assertEqual(P('a/.hg.rc').suffixes, ['.rc'])
542 self.assertEqual(P('/a/.hg.rc').suffixes, ['.rc'])
543 self.assertEqual(P('a/b.tar.gz').suffixes, ['.tar', '.gz'])
544 self.assertEqual(P('/a/b.tar.gz').suffixes, ['.tar', '.gz'])
545 self.assertEqual(P('a/Some name. Ending with a dot.').suffixes, [])
546 self.assertEqual(P('/a/Some name. Ending with a dot.').suffixes, [])
547
548 def test_stem_common(self):
549 P = self.cls
550 self.assertEqual(P('').stem, '')
551 self.assertEqual(P('.').stem, '')
552 self.assertEqual(P('..').stem, '..')
553 self.assertEqual(P('/').stem, '')
554 self.assertEqual(P('a/b').stem, 'b')
555 self.assertEqual(P('a/b.py').stem, 'b')
556 self.assertEqual(P('a/.hgrc').stem, '.hgrc')
557 self.assertEqual(P('a/.hg.rc').stem, '.hg')
558 self.assertEqual(P('a/b.tar.gz').stem, 'b.tar')
559 self.assertEqual(P('a/Some name. Ending with a dot.').stem,
560 'Some name. Ending with a dot.')
561
562 def test_with_name_common(self):
563 P = self.cls
564 self.assertEqual(P('a/b').with_name('d.xml'), P('a/d.xml'))
565 self.assertEqual(P('/a/b').with_name('d.xml'), P('/a/d.xml'))
566 self.assertEqual(P('a/b.py').with_name('d.xml'), P('a/d.xml'))
567 self.assertEqual(P('/a/b.py').with_name('d.xml'), P('/a/d.xml'))
568 self.assertEqual(P('a/Dot ending.').with_name('d.xml'), P('a/d.xml'))
569 self.assertEqual(P('/a/Dot ending.').with_name('d.xml'), P('/a/d.xml'))
570 self.assertRaises(ValueError, P('').with_name, 'd.xml')
571 self.assertRaises(ValueError, P('.').with_name, 'd.xml')
572 self.assertRaises(ValueError, P('/').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400573 self.assertRaises(ValueError, P('a/b').with_name, '')
574 self.assertRaises(ValueError, P('a/b').with_name, '/c')
575 self.assertRaises(ValueError, P('a/b').with_name, 'c/')
576 self.assertRaises(ValueError, P('a/b').with_name, 'c/d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100577
Tim Hoffmann8aea4b32020-04-19 17:29:49 +0200578 def test_with_stem_common(self):
579 P = self.cls
580 self.assertEqual(P('a/b').with_stem('d'), P('a/d'))
581 self.assertEqual(P('/a/b').with_stem('d'), P('/a/d'))
582 self.assertEqual(P('a/b.py').with_stem('d'), P('a/d.py'))
583 self.assertEqual(P('/a/b.py').with_stem('d'), P('/a/d.py'))
584 self.assertEqual(P('/a/b.tar.gz').with_stem('d'), P('/a/d.gz'))
585 self.assertEqual(P('a/Dot ending.').with_stem('d'), P('a/d'))
586 self.assertEqual(P('/a/Dot ending.').with_stem('d'), P('/a/d'))
587 self.assertRaises(ValueError, P('').with_stem, 'd')
588 self.assertRaises(ValueError, P('.').with_stem, 'd')
589 self.assertRaises(ValueError, P('/').with_stem, 'd')
590 self.assertRaises(ValueError, P('a/b').with_stem, '')
591 self.assertRaises(ValueError, P('a/b').with_stem, '/c')
592 self.assertRaises(ValueError, P('a/b').with_stem, 'c/')
593 self.assertRaises(ValueError, P('a/b').with_stem, 'c/d')
594
Antoine Pitrou31119e42013-11-22 17:38:12 +0100595 def test_with_suffix_common(self):
596 P = self.cls
597 self.assertEqual(P('a/b').with_suffix('.gz'), P('a/b.gz'))
598 self.assertEqual(P('/a/b').with_suffix('.gz'), P('/a/b.gz'))
599 self.assertEqual(P('a/b.py').with_suffix('.gz'), P('a/b.gz'))
600 self.assertEqual(P('/a/b.py').with_suffix('.gz'), P('/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100601 # Stripping suffix.
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400602 self.assertEqual(P('a/b.py').with_suffix(''), P('a/b'))
603 self.assertEqual(P('/a/b').with_suffix(''), P('/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100604 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100605 self.assertRaises(ValueError, P('').with_suffix, '.gz')
606 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
607 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +1100608 # Invalid 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, '/')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400611 self.assertRaises(ValueError, P('a/b').with_suffix, '.')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100612 self.assertRaises(ValueError, P('a/b').with_suffix, '/.gz')
613 self.assertRaises(ValueError, P('a/b').with_suffix, 'c/d')
614 self.assertRaises(ValueError, P('a/b').with_suffix, '.c/.d')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400615 self.assertRaises(ValueError, P('a/b').with_suffix, './.d')
616 self.assertRaises(ValueError, P('a/b').with_suffix, '.d/.')
Berker Peksag423d05f2018-08-11 08:45:06 +0300617 self.assertRaises(ValueError, P('a/b').with_suffix,
618 (self.flavour.sep, 'd'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100619
620 def test_relative_to_common(self):
621 P = self.cls
622 p = P('a/b')
623 self.assertRaises(TypeError, p.relative_to)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100624 self.assertRaises(TypeError, p.relative_to, b'a')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100625 self.assertEqual(p.relative_to(P()), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100626 self.assertEqual(p.relative_to(''), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100627 self.assertEqual(p.relative_to(P('a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100628 self.assertEqual(p.relative_to('a'), P('b'))
629 self.assertEqual(p.relative_to('a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100630 self.assertEqual(p.relative_to(P('a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100631 self.assertEqual(p.relative_to('a/b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100632 # With several args.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100633 self.assertEqual(p.relative_to('a', 'b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100634 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100635 self.assertRaises(ValueError, p.relative_to, P('c'))
636 self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
637 self.assertRaises(ValueError, p.relative_to, P('a/c'))
638 self.assertRaises(ValueError, p.relative_to, P('/a'))
639 p = P('/a/b')
640 self.assertEqual(p.relative_to(P('/')), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100641 self.assertEqual(p.relative_to('/'), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100642 self.assertEqual(p.relative_to(P('/a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100643 self.assertEqual(p.relative_to('/a'), P('b'))
644 self.assertEqual(p.relative_to('/a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100645 self.assertEqual(p.relative_to(P('/a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100646 self.assertEqual(p.relative_to('/a/b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100647 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100648 self.assertRaises(ValueError, p.relative_to, P('/c'))
649 self.assertRaises(ValueError, p.relative_to, P('/a/b/c'))
650 self.assertRaises(ValueError, p.relative_to, P('/a/c'))
651 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100652 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100653 self.assertRaises(ValueError, p.relative_to, P('a'))
654
Hai Shi82642a02019-08-13 14:54:02 -0500655 def test_is_relative_to_common(self):
656 P = self.cls
657 p = P('a/b')
658 self.assertRaises(TypeError, p.is_relative_to)
659 self.assertRaises(TypeError, p.is_relative_to, b'a')
660 self.assertTrue(p.is_relative_to(P()))
661 self.assertTrue(p.is_relative_to(''))
662 self.assertTrue(p.is_relative_to(P('a')))
663 self.assertTrue(p.is_relative_to('a/'))
664 self.assertTrue(p.is_relative_to(P('a/b')))
665 self.assertTrue(p.is_relative_to('a/b'))
666 # With several args.
667 self.assertTrue(p.is_relative_to('a', 'b'))
668 # Unrelated paths.
669 self.assertFalse(p.is_relative_to(P('c')))
670 self.assertFalse(p.is_relative_to(P('a/b/c')))
671 self.assertFalse(p.is_relative_to(P('a/c')))
672 self.assertFalse(p.is_relative_to(P('/a')))
673 p = P('/a/b')
674 self.assertTrue(p.is_relative_to(P('/')))
675 self.assertTrue(p.is_relative_to('/'))
676 self.assertTrue(p.is_relative_to(P('/a')))
677 self.assertTrue(p.is_relative_to('/a'))
678 self.assertTrue(p.is_relative_to('/a/'))
679 self.assertTrue(p.is_relative_to(P('/a/b')))
680 self.assertTrue(p.is_relative_to('/a/b'))
681 # Unrelated paths.
682 self.assertFalse(p.is_relative_to(P('/c')))
683 self.assertFalse(p.is_relative_to(P('/a/b/c')))
684 self.assertFalse(p.is_relative_to(P('/a/c')))
685 self.assertFalse(p.is_relative_to(P()))
686 self.assertFalse(p.is_relative_to(''))
687 self.assertFalse(p.is_relative_to(P('a')))
688
Antoine Pitrou31119e42013-11-22 17:38:12 +0100689 def test_pickling_common(self):
690 P = self.cls
691 p = P('/a/b')
692 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
693 dumped = pickle.dumps(p, proto)
694 pp = pickle.loads(dumped)
695 self.assertIs(pp.__class__, p.__class__)
696 self.assertEqual(pp, p)
697 self.assertEqual(hash(pp), hash(p))
698 self.assertEqual(str(pp), str(p))
699
700
701class PurePosixPathTest(_BasePurePathTest, unittest.TestCase):
702 cls = pathlib.PurePosixPath
703
704 def test_root(self):
705 P = self.cls
706 self.assertEqual(P('/a/b').root, '/')
707 self.assertEqual(P('///a/b').root, '/')
Anthony Shaw83da9262019-01-07 07:31:29 +1100708 # POSIX special case for two leading slashes.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100709 self.assertEqual(P('//a/b').root, '//')
710
711 def test_eq(self):
712 P = self.cls
713 self.assertNotEqual(P('a/b'), P('A/b'))
714 self.assertEqual(P('/a'), P('///a'))
715 self.assertNotEqual(P('/a'), P('//a'))
716
717 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100718 P = self.cls
719 self.assertEqual(P('/').as_uri(), 'file:///')
720 self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')
721 self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')
Antoine Pitrou29eac422013-11-22 17:57:03 +0100722
723 def test_as_uri_non_ascii(self):
724 from urllib.parse import quote_from_bytes
725 P = self.cls
726 try:
727 os.fsencode('\xe9')
728 except UnicodeEncodeError:
729 self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")
Antoine Pitrou31119e42013-11-22 17:38:12 +0100730 self.assertEqual(P('/a/b\xe9').as_uri(),
731 'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))
732
733 def test_match(self):
734 P = self.cls
735 self.assertFalse(P('A.py').match('a.PY'))
736
737 def test_is_absolute(self):
738 P = self.cls
739 self.assertFalse(P().is_absolute())
740 self.assertFalse(P('a').is_absolute())
741 self.assertFalse(P('a/b/').is_absolute())
742 self.assertTrue(P('/').is_absolute())
743 self.assertTrue(P('/a').is_absolute())
744 self.assertTrue(P('/a/b/').is_absolute())
745 self.assertTrue(P('//a').is_absolute())
746 self.assertTrue(P('//a/b').is_absolute())
747
748 def test_is_reserved(self):
749 P = self.cls
750 self.assertIs(False, P('').is_reserved())
751 self.assertIs(False, P('/').is_reserved())
752 self.assertIs(False, P('/foo/bar').is_reserved())
753 self.assertIs(False, P('/dev/con/PRN/NUL').is_reserved())
754
755 def test_join(self):
756 P = self.cls
757 p = P('//a')
758 pp = p.joinpath('b')
759 self.assertEqual(pp, P('//a/b'))
760 pp = P('/a').joinpath('//c')
761 self.assertEqual(pp, P('//c'))
762 pp = P('//a').joinpath('/c')
763 self.assertEqual(pp, P('/c'))
764
765 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100766 # Basically the same as joinpath().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100767 P = self.cls
768 p = P('//a')
769 pp = p / 'b'
770 self.assertEqual(pp, P('//a/b'))
771 pp = P('/a') / '//c'
772 self.assertEqual(pp, P('//c'))
773 pp = P('//a') / '/c'
774 self.assertEqual(pp, P('/c'))
775
776
777class PureWindowsPathTest(_BasePurePathTest, unittest.TestCase):
778 cls = pathlib.PureWindowsPath
779
780 equivalences = _BasePurePathTest.equivalences.copy()
781 equivalences.update({
782 'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('/', 'c:', 'a') ],
783 'c:/a': [
784 ('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),
785 ('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),
786 ],
787 '//a/b/': [ ('//a/b',) ],
788 '//a/b/c': [
789 ('//a/b', 'c'), ('//a/b/', 'c'),
790 ],
791 })
792
793 def test_str(self):
794 p = self.cls('a/b/c')
795 self.assertEqual(str(p), 'a\\b\\c')
796 p = self.cls('c:/a/b/c')
797 self.assertEqual(str(p), 'c:\\a\\b\\c')
798 p = self.cls('//a/b')
799 self.assertEqual(str(p), '\\\\a\\b\\')
800 p = self.cls('//a/b/c')
801 self.assertEqual(str(p), '\\\\a\\b\\c')
802 p = self.cls('//a/b/c/d')
803 self.assertEqual(str(p), '\\\\a\\b\\c\\d')
804
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200805 def test_str_subclass(self):
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('c:\\')
810 self._check_str_subclass('c:\\a')
811 self._check_str_subclass('c:\\a\\b.txt')
812 self._check_str_subclass('\\\\some\\share')
813 self._check_str_subclass('\\\\some\\share\\a')
814 self._check_str_subclass('\\\\some\\share\\a\\b.txt')
815
Antoine Pitrou31119e42013-11-22 17:38:12 +0100816 def test_eq(self):
817 P = self.cls
818 self.assertEqual(P('c:a/b'), P('c:a/b'))
819 self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))
820 self.assertNotEqual(P('c:a/b'), P('d:a/b'))
821 self.assertNotEqual(P('c:a/b'), P('c:/a/b'))
822 self.assertNotEqual(P('/a/b'), P('c:/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100823 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100824 self.assertEqual(P('a/B'), P('A/b'))
825 self.assertEqual(P('C:a/B'), P('c:A/b'))
826 self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))
827
828 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100829 P = self.cls
830 with self.assertRaises(ValueError):
831 P('/a/b').as_uri()
832 with self.assertRaises(ValueError):
833 P('c:a/b').as_uri()
834 self.assertEqual(P('c:/').as_uri(), 'file:///c:/')
835 self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')
836 self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')
837 self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')
838 self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')
839 self.assertEqual(P('//some/share/a/b.c').as_uri(),
840 'file://some/share/a/b.c')
841 self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),
842 'file://some/share/a/b%25%23c%C3%A9')
843
844 def test_match_common(self):
845 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +1100846 # Absolute patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100847 self.assertTrue(P('c:/b.py').match('/*.py'))
848 self.assertTrue(P('c:/b.py').match('c:*.py'))
849 self.assertTrue(P('c:/b.py').match('c:/*.py'))
850 self.assertFalse(P('d:/b.py').match('c:/*.py')) # wrong drive
851 self.assertFalse(P('b.py').match('/*.py'))
852 self.assertFalse(P('b.py').match('c:*.py'))
853 self.assertFalse(P('b.py').match('c:/*.py'))
854 self.assertFalse(P('c:b.py').match('/*.py'))
855 self.assertFalse(P('c:b.py').match('c:/*.py'))
856 self.assertFalse(P('/b.py').match('c:*.py'))
857 self.assertFalse(P('/b.py').match('c:/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100858 # UNC patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100859 self.assertTrue(P('//some/share/a.py').match('/*.py'))
860 self.assertTrue(P('//some/share/a.py').match('//some/share/*.py'))
861 self.assertFalse(P('//other/share/a.py').match('//some/share/*.py'))
862 self.assertFalse(P('//some/share/a/b.py').match('//some/share/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100863 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100864 self.assertTrue(P('B.py').match('b.PY'))
865 self.assertTrue(P('c:/a/B.Py').match('C:/A/*.pY'))
866 self.assertTrue(P('//Some/Share/B.Py').match('//somE/sharE/*.pY'))
867
868 def test_ordering_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100869 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100870 def assertOrderedEqual(a, b):
871 self.assertLessEqual(a, b)
872 self.assertGreaterEqual(b, a)
873 P = self.cls
874 p = P('c:A/b')
875 q = P('C:a/B')
876 assertOrderedEqual(p, q)
877 self.assertFalse(p < q)
878 self.assertFalse(p > q)
879 p = P('//some/Share/A/b')
880 q = P('//Some/SHARE/a/B')
881 assertOrderedEqual(p, q)
882 self.assertFalse(p < q)
883 self.assertFalse(p > q)
884
885 def test_parts(self):
886 P = self.cls
887 p = P('c:a/b')
888 parts = p.parts
889 self.assertEqual(parts, ('c:', 'a', 'b'))
890 p = P('c:/a/b')
891 parts = p.parts
892 self.assertEqual(parts, ('c:\\', 'a', 'b'))
893 p = P('//a/b/c/d')
894 parts = p.parts
895 self.assertEqual(parts, ('\\\\a\\b\\', 'c', 'd'))
896
897 def test_parent(self):
898 # Anchored
899 P = self.cls
900 p = P('z:a/b/c')
901 self.assertEqual(p.parent, P('z:a/b'))
902 self.assertEqual(p.parent.parent, P('z:a'))
903 self.assertEqual(p.parent.parent.parent, P('z:'))
904 self.assertEqual(p.parent.parent.parent.parent, P('z:'))
905 p = P('z:/a/b/c')
906 self.assertEqual(p.parent, P('z:/a/b'))
907 self.assertEqual(p.parent.parent, P('z:/a'))
908 self.assertEqual(p.parent.parent.parent, P('z:/'))
909 self.assertEqual(p.parent.parent.parent.parent, P('z:/'))
910 p = P('//a/b/c/d')
911 self.assertEqual(p.parent, P('//a/b/c'))
912 self.assertEqual(p.parent.parent, P('//a/b'))
913 self.assertEqual(p.parent.parent.parent, P('//a/b'))
914
915 def test_parents(self):
916 # Anchored
917 P = self.cls
918 p = P('z:a/b/')
919 par = p.parents
920 self.assertEqual(len(par), 2)
921 self.assertEqual(par[0], P('z:a'))
922 self.assertEqual(par[1], P('z:'))
Joshua Cannon45205842020-11-20 09:40:39 -0600923 self.assertEqual(par[0:1], (P('z:a'),))
924 self.assertEqual(par[:-1], (P('z:a'),))
925 self.assertEqual(par[:2], (P('z:a'), P('z:')))
926 self.assertEqual(par[1:], (P('z:'),))
927 self.assertEqual(par[::2], (P('z:a'),))
928 self.assertEqual(par[::-1], (P('z:'), P('z:a')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100929 self.assertEqual(list(par), [P('z:a'), P('z:')])
930 with self.assertRaises(IndexError):
931 par[2]
932 p = P('z:/a/b/')
933 par = p.parents
934 self.assertEqual(len(par), 2)
935 self.assertEqual(par[0], P('z:/a'))
936 self.assertEqual(par[1], P('z:/'))
Joshua Cannon45205842020-11-20 09:40:39 -0600937 self.assertEqual(par[0:1], (P('z:/a'),))
938 self.assertEqual(par[0:-1], (P('z:/a'),))
939 self.assertEqual(par[:2], (P('z:/a'), P('z:/')))
940 self.assertEqual(par[1:], (P('z:/'),))
941 self.assertEqual(par[::2], (P('z:/a'),))
942 self.assertEqual(par[::-1], (P('z:/'), P('z:/a'),))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100943 self.assertEqual(list(par), [P('z:/a'), P('z:/')])
944 with self.assertRaises(IndexError):
945 par[2]
946 p = P('//a/b/c/d')
947 par = p.parents
948 self.assertEqual(len(par), 2)
949 self.assertEqual(par[0], P('//a/b/c'))
950 self.assertEqual(par[1], P('//a/b'))
Joshua Cannon45205842020-11-20 09:40:39 -0600951 self.assertEqual(par[0:1], (P('//a/b/c'),))
952 self.assertEqual(par[0:-1], (P('//a/b/c'),))
953 self.assertEqual(par[:2], (P('//a/b/c'), P('//a/b')))
954 self.assertEqual(par[1:], (P('//a/b'),))
955 self.assertEqual(par[::2], (P('//a/b/c'),))
956 self.assertEqual(par[::-1], (P('//a/b'), P('//a/b/c')))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100957 self.assertEqual(list(par), [P('//a/b/c'), P('//a/b')])
958 with self.assertRaises(IndexError):
959 par[2]
960
961 def test_drive(self):
962 P = self.cls
963 self.assertEqual(P('c:').drive, 'c:')
964 self.assertEqual(P('c:a/b').drive, 'c:')
965 self.assertEqual(P('c:/').drive, 'c:')
966 self.assertEqual(P('c:/a/b/').drive, 'c:')
967 self.assertEqual(P('//a/b').drive, '\\\\a\\b')
968 self.assertEqual(P('//a/b/').drive, '\\\\a\\b')
969 self.assertEqual(P('//a/b/c/d').drive, '\\\\a\\b')
970
971 def test_root(self):
972 P = self.cls
973 self.assertEqual(P('c:').root, '')
974 self.assertEqual(P('c:a/b').root, '')
975 self.assertEqual(P('c:/').root, '\\')
976 self.assertEqual(P('c:/a/b/').root, '\\')
977 self.assertEqual(P('//a/b').root, '\\')
978 self.assertEqual(P('//a/b/').root, '\\')
979 self.assertEqual(P('//a/b/c/d').root, '\\')
980
981 def test_anchor(self):
982 P = self.cls
983 self.assertEqual(P('c:').anchor, 'c:')
984 self.assertEqual(P('c:a/b').anchor, 'c:')
985 self.assertEqual(P('c:/').anchor, 'c:\\')
986 self.assertEqual(P('c:/a/b/').anchor, 'c:\\')
987 self.assertEqual(P('//a/b').anchor, '\\\\a\\b\\')
988 self.assertEqual(P('//a/b/').anchor, '\\\\a\\b\\')
989 self.assertEqual(P('//a/b/c/d').anchor, '\\\\a\\b\\')
990
991 def test_name(self):
992 P = self.cls
993 self.assertEqual(P('c:').name, '')
994 self.assertEqual(P('c:/').name, '')
995 self.assertEqual(P('c:a/b').name, 'b')
996 self.assertEqual(P('c:/a/b').name, 'b')
997 self.assertEqual(P('c:a/b.py').name, 'b.py')
998 self.assertEqual(P('c:/a/b.py').name, 'b.py')
999 self.assertEqual(P('//My.py/Share.php').name, '')
1000 self.assertEqual(P('//My.py/Share.php/a/b').name, 'b')
1001
1002 def test_suffix(self):
1003 P = self.cls
1004 self.assertEqual(P('c:').suffix, '')
1005 self.assertEqual(P('c:/').suffix, '')
1006 self.assertEqual(P('c:a/b').suffix, '')
1007 self.assertEqual(P('c:/a/b').suffix, '')
1008 self.assertEqual(P('c:a/b.py').suffix, '.py')
1009 self.assertEqual(P('c:/a/b.py').suffix, '.py')
1010 self.assertEqual(P('c:a/.hgrc').suffix, '')
1011 self.assertEqual(P('c:/a/.hgrc').suffix, '')
1012 self.assertEqual(P('c:a/.hg.rc').suffix, '.rc')
1013 self.assertEqual(P('c:/a/.hg.rc').suffix, '.rc')
1014 self.assertEqual(P('c:a/b.tar.gz').suffix, '.gz')
1015 self.assertEqual(P('c:/a/b.tar.gz').suffix, '.gz')
1016 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffix, '')
1017 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffix, '')
1018 self.assertEqual(P('//My.py/Share.php').suffix, '')
1019 self.assertEqual(P('//My.py/Share.php/a/b').suffix, '')
1020
1021 def test_suffixes(self):
1022 P = self.cls
1023 self.assertEqual(P('c:').suffixes, [])
1024 self.assertEqual(P('c:/').suffixes, [])
1025 self.assertEqual(P('c:a/b').suffixes, [])
1026 self.assertEqual(P('c:/a/b').suffixes, [])
1027 self.assertEqual(P('c:a/b.py').suffixes, ['.py'])
1028 self.assertEqual(P('c:/a/b.py').suffixes, ['.py'])
1029 self.assertEqual(P('c:a/.hgrc').suffixes, [])
1030 self.assertEqual(P('c:/a/.hgrc').suffixes, [])
1031 self.assertEqual(P('c:a/.hg.rc').suffixes, ['.rc'])
1032 self.assertEqual(P('c:/a/.hg.rc').suffixes, ['.rc'])
1033 self.assertEqual(P('c:a/b.tar.gz').suffixes, ['.tar', '.gz'])
1034 self.assertEqual(P('c:/a/b.tar.gz').suffixes, ['.tar', '.gz'])
1035 self.assertEqual(P('//My.py/Share.php').suffixes, [])
1036 self.assertEqual(P('//My.py/Share.php/a/b').suffixes, [])
1037 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffixes, [])
1038 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffixes, [])
1039
1040 def test_stem(self):
1041 P = self.cls
1042 self.assertEqual(P('c:').stem, '')
1043 self.assertEqual(P('c:.').stem, '')
1044 self.assertEqual(P('c:..').stem, '..')
1045 self.assertEqual(P('c:/').stem, '')
1046 self.assertEqual(P('c:a/b').stem, 'b')
1047 self.assertEqual(P('c:a/b.py').stem, 'b')
1048 self.assertEqual(P('c:a/.hgrc').stem, '.hgrc')
1049 self.assertEqual(P('c:a/.hg.rc').stem, '.hg')
1050 self.assertEqual(P('c:a/b.tar.gz').stem, 'b.tar')
1051 self.assertEqual(P('c:a/Some name. Ending with a dot.').stem,
1052 'Some name. Ending with a dot.')
1053
1054 def test_with_name(self):
1055 P = self.cls
1056 self.assertEqual(P('c:a/b').with_name('d.xml'), P('c:a/d.xml'))
1057 self.assertEqual(P('c:/a/b').with_name('d.xml'), P('c:/a/d.xml'))
1058 self.assertEqual(P('c:a/Dot ending.').with_name('d.xml'), P('c:a/d.xml'))
1059 self.assertEqual(P('c:/a/Dot ending.').with_name('d.xml'), P('c:/a/d.xml'))
1060 self.assertRaises(ValueError, P('c:').with_name, 'd.xml')
1061 self.assertRaises(ValueError, P('c:/').with_name, 'd.xml')
1062 self.assertRaises(ValueError, P('//My/Share').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -04001063 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:')
1064 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:e')
1065 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:/e')
1066 self.assertRaises(ValueError, P('c:a/b').with_name, '//My/Share')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001067
Tim Hoffmann8aea4b32020-04-19 17:29:49 +02001068 def test_with_stem(self):
1069 P = self.cls
1070 self.assertEqual(P('c:a/b').with_stem('d'), P('c:a/d'))
1071 self.assertEqual(P('c:/a/b').with_stem('d'), P('c:/a/d'))
1072 self.assertEqual(P('c:a/Dot ending.').with_stem('d'), P('c:a/d'))
1073 self.assertEqual(P('c:/a/Dot ending.').with_stem('d'), P('c:/a/d'))
1074 self.assertRaises(ValueError, P('c:').with_stem, 'd')
1075 self.assertRaises(ValueError, P('c:/').with_stem, 'd')
1076 self.assertRaises(ValueError, P('//My/Share').with_stem, 'd')
1077 self.assertRaises(ValueError, P('c:a/b').with_stem, 'd:')
1078 self.assertRaises(ValueError, P('c:a/b').with_stem, 'd:e')
1079 self.assertRaises(ValueError, P('c:a/b').with_stem, 'd:/e')
1080 self.assertRaises(ValueError, P('c:a/b').with_stem, '//My/Share')
1081
Antoine Pitrou31119e42013-11-22 17:38:12 +01001082 def test_with_suffix(self):
1083 P = self.cls
1084 self.assertEqual(P('c:a/b').with_suffix('.gz'), P('c:a/b.gz'))
1085 self.assertEqual(P('c:/a/b').with_suffix('.gz'), P('c:/a/b.gz'))
1086 self.assertEqual(P('c:a/b.py').with_suffix('.gz'), P('c:a/b.gz'))
1087 self.assertEqual(P('c:/a/b.py').with_suffix('.gz'), P('c:/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001088 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001089 self.assertRaises(ValueError, P('').with_suffix, '.gz')
1090 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
1091 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
1092 self.assertRaises(ValueError, P('//My/Share').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +11001093 # Invalid suffix.
Antoine Pitrou1b02da92014-01-03 00:07:17 +01001094 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'gz')
1095 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/')
1096 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\')
1097 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:')
1098 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/.gz')
1099 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\.gz')
1100 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:.gz')
1101 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c/d')
1102 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c\\d')
1103 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c/d')
1104 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c\\d')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001105
1106 def test_relative_to(self):
1107 P = self.cls
Antoine Pitrou156b3612013-12-28 19:49:04 +01001108 p = P('C:Foo/Bar')
1109 self.assertEqual(p.relative_to(P('c:')), P('Foo/Bar'))
1110 self.assertEqual(p.relative_to('c:'), P('Foo/Bar'))
1111 self.assertEqual(p.relative_to(P('c:foO')), P('Bar'))
1112 self.assertEqual(p.relative_to('c:foO'), P('Bar'))
1113 self.assertEqual(p.relative_to('c:foO/'), P('Bar'))
1114 self.assertEqual(p.relative_to(P('c:foO/baR')), P())
1115 self.assertEqual(p.relative_to('c:foO/baR'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001116 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001117 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +01001118 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001119 self.assertRaises(ValueError, p.relative_to, P('d:'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001120 self.assertRaises(ValueError, p.relative_to, P('/'))
1121 self.assertRaises(ValueError, p.relative_to, P('Foo'))
1122 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1123 self.assertRaises(ValueError, p.relative_to, P('C:/Foo'))
1124 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Bar/Baz'))
1125 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Baz'))
1126 p = P('C:/Foo/Bar')
1127 self.assertEqual(p.relative_to(P('c:')), P('/Foo/Bar'))
1128 self.assertEqual(p.relative_to('c:'), P('/Foo/Bar'))
1129 self.assertEqual(str(p.relative_to(P('c:'))), '\\Foo\\Bar')
1130 self.assertEqual(str(p.relative_to('c:')), '\\Foo\\Bar')
1131 self.assertEqual(p.relative_to(P('c:/')), P('Foo/Bar'))
1132 self.assertEqual(p.relative_to('c:/'), P('Foo/Bar'))
1133 self.assertEqual(p.relative_to(P('c:/foO')), P('Bar'))
1134 self.assertEqual(p.relative_to('c:/foO'), P('Bar'))
1135 self.assertEqual(p.relative_to('c:/foO/'), P('Bar'))
1136 self.assertEqual(p.relative_to(P('c:/foO/baR')), P())
1137 self.assertEqual(p.relative_to('c:/foO/baR'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001138 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001139 self.assertRaises(ValueError, p.relative_to, P('C:/Baz'))
1140 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Bar/Baz'))
1141 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Baz'))
1142 self.assertRaises(ValueError, p.relative_to, P('C:Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001143 self.assertRaises(ValueError, p.relative_to, P('d:'))
1144 self.assertRaises(ValueError, p.relative_to, P('d:/'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001145 self.assertRaises(ValueError, p.relative_to, P('/'))
1146 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1147 self.assertRaises(ValueError, p.relative_to, P('//C/Foo'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001148 # UNC paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001149 p = P('//Server/Share/Foo/Bar')
1150 self.assertEqual(p.relative_to(P('//sErver/sHare')), P('Foo/Bar'))
1151 self.assertEqual(p.relative_to('//sErver/sHare'), P('Foo/Bar'))
1152 self.assertEqual(p.relative_to('//sErver/sHare/'), P('Foo/Bar'))
1153 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo')), P('Bar'))
1154 self.assertEqual(p.relative_to('//sErver/sHare/Foo'), P('Bar'))
1155 self.assertEqual(p.relative_to('//sErver/sHare/Foo/'), P('Bar'))
1156 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo/Bar')), P())
1157 self.assertEqual(p.relative_to('//sErver/sHare/Foo/Bar'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001158 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001159 self.assertRaises(ValueError, p.relative_to, P('/Server/Share/Foo'))
1160 self.assertRaises(ValueError, p.relative_to, P('c:/Server/Share/Foo'))
1161 self.assertRaises(ValueError, p.relative_to, P('//z/Share/Foo'))
1162 self.assertRaises(ValueError, p.relative_to, P('//Server/z/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001163
Hai Shi82642a02019-08-13 14:54:02 -05001164 def test_is_relative_to(self):
1165 P = self.cls
1166 p = P('C:Foo/Bar')
1167 self.assertTrue(p.is_relative_to(P('c:')))
1168 self.assertTrue(p.is_relative_to('c:'))
1169 self.assertTrue(p.is_relative_to(P('c:foO')))
1170 self.assertTrue(p.is_relative_to('c:foO'))
1171 self.assertTrue(p.is_relative_to('c:foO/'))
1172 self.assertTrue(p.is_relative_to(P('c:foO/baR')))
1173 self.assertTrue(p.is_relative_to('c:foO/baR'))
1174 # Unrelated paths.
1175 self.assertFalse(p.is_relative_to(P()))
1176 self.assertFalse(p.is_relative_to(''))
1177 self.assertFalse(p.is_relative_to(P('d:')))
1178 self.assertFalse(p.is_relative_to(P('/')))
1179 self.assertFalse(p.is_relative_to(P('Foo')))
1180 self.assertFalse(p.is_relative_to(P('/Foo')))
1181 self.assertFalse(p.is_relative_to(P('C:/Foo')))
1182 self.assertFalse(p.is_relative_to(P('C:Foo/Bar/Baz')))
1183 self.assertFalse(p.is_relative_to(P('C:Foo/Baz')))
1184 p = P('C:/Foo/Bar')
1185 self.assertTrue(p.is_relative_to('c:'))
1186 self.assertTrue(p.is_relative_to(P('c:/')))
1187 self.assertTrue(p.is_relative_to(P('c:/foO')))
1188 self.assertTrue(p.is_relative_to('c:/foO/'))
1189 self.assertTrue(p.is_relative_to(P('c:/foO/baR')))
1190 self.assertTrue(p.is_relative_to('c:/foO/baR'))
1191 # Unrelated paths.
1192 self.assertFalse(p.is_relative_to(P('C:/Baz')))
1193 self.assertFalse(p.is_relative_to(P('C:/Foo/Bar/Baz')))
1194 self.assertFalse(p.is_relative_to(P('C:/Foo/Baz')))
1195 self.assertFalse(p.is_relative_to(P('C:Foo')))
1196 self.assertFalse(p.is_relative_to(P('d:')))
1197 self.assertFalse(p.is_relative_to(P('d:/')))
1198 self.assertFalse(p.is_relative_to(P('/')))
1199 self.assertFalse(p.is_relative_to(P('/Foo')))
1200 self.assertFalse(p.is_relative_to(P('//C/Foo')))
1201 # UNC paths.
1202 p = P('//Server/Share/Foo/Bar')
1203 self.assertTrue(p.is_relative_to(P('//sErver/sHare')))
1204 self.assertTrue(p.is_relative_to('//sErver/sHare'))
1205 self.assertTrue(p.is_relative_to('//sErver/sHare/'))
1206 self.assertTrue(p.is_relative_to(P('//sErver/sHare/Foo')))
1207 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo'))
1208 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo/'))
1209 self.assertTrue(p.is_relative_to(P('//sErver/sHare/Foo/Bar')))
1210 self.assertTrue(p.is_relative_to('//sErver/sHare/Foo/Bar'))
1211 # Unrelated paths.
1212 self.assertFalse(p.is_relative_to(P('/Server/Share/Foo')))
1213 self.assertFalse(p.is_relative_to(P('c:/Server/Share/Foo')))
1214 self.assertFalse(p.is_relative_to(P('//z/Share/Foo')))
1215 self.assertFalse(p.is_relative_to(P('//Server/z/Foo')))
1216
Antoine Pitrou31119e42013-11-22 17:38:12 +01001217 def test_is_absolute(self):
1218 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +11001219 # Under NT, only paths with both a drive and a root are absolute.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001220 self.assertFalse(P().is_absolute())
1221 self.assertFalse(P('a').is_absolute())
1222 self.assertFalse(P('a/b/').is_absolute())
1223 self.assertFalse(P('/').is_absolute())
1224 self.assertFalse(P('/a').is_absolute())
1225 self.assertFalse(P('/a/b/').is_absolute())
1226 self.assertFalse(P('c:').is_absolute())
1227 self.assertFalse(P('c:a').is_absolute())
1228 self.assertFalse(P('c:a/b/').is_absolute())
1229 self.assertTrue(P('c:/').is_absolute())
1230 self.assertTrue(P('c:/a').is_absolute())
1231 self.assertTrue(P('c:/a/b/').is_absolute())
Anthony Shaw83da9262019-01-07 07:31:29 +11001232 # UNC paths are absolute by definition.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001233 self.assertTrue(P('//a/b').is_absolute())
1234 self.assertTrue(P('//a/b/').is_absolute())
1235 self.assertTrue(P('//a/b/c').is_absolute())
1236 self.assertTrue(P('//a/b/c/d').is_absolute())
1237
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001238 def test_join(self):
1239 P = self.cls
1240 p = P('C:/a/b')
1241 pp = p.joinpath('x/y')
1242 self.assertEqual(pp, P('C:/a/b/x/y'))
1243 pp = p.joinpath('/x/y')
1244 self.assertEqual(pp, P('C:/x/y'))
1245 # Joining with a different drive => the first path is ignored, even
1246 # if the second path is relative.
1247 pp = p.joinpath('D:x/y')
1248 self.assertEqual(pp, P('D:x/y'))
1249 pp = p.joinpath('D:/x/y')
1250 self.assertEqual(pp, P('D:/x/y'))
1251 pp = p.joinpath('//host/share/x/y')
1252 self.assertEqual(pp, P('//host/share/x/y'))
1253 # Joining with the same drive => the first path is appended to if
1254 # the second path is relative.
1255 pp = p.joinpath('c:x/y')
1256 self.assertEqual(pp, P('C:/a/b/x/y'))
1257 pp = p.joinpath('c:/x/y')
1258 self.assertEqual(pp, P('C:/x/y'))
1259
1260 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001261 # Basically the same as joinpath().
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001262 P = self.cls
1263 p = P('C:/a/b')
1264 self.assertEqual(p / 'x/y', P('C:/a/b/x/y'))
1265 self.assertEqual(p / 'x' / 'y', P('C:/a/b/x/y'))
1266 self.assertEqual(p / '/x/y', P('C:/x/y'))
1267 self.assertEqual(p / '/x' / 'y', P('C:/x/y'))
1268 # Joining with a different drive => the first path is ignored, even
1269 # if the second path is relative.
1270 self.assertEqual(p / 'D:x/y', P('D:x/y'))
1271 self.assertEqual(p / 'D:' / 'x/y', P('D:x/y'))
1272 self.assertEqual(p / 'D:/x/y', P('D:/x/y'))
1273 self.assertEqual(p / 'D:' / '/x/y', P('D:/x/y'))
1274 self.assertEqual(p / '//host/share/x/y', P('//host/share/x/y'))
1275 # Joining with the same drive => the first path is appended to if
1276 # the second path is relative.
Serhiy Storchaka010ff582013-12-06 17:25:51 +02001277 self.assertEqual(p / 'c:x/y', P('C:/a/b/x/y'))
1278 self.assertEqual(p / 'c:/x/y', P('C:/x/y'))
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001279
Antoine Pitrou31119e42013-11-22 17:38:12 +01001280 def test_is_reserved(self):
1281 P = self.cls
1282 self.assertIs(False, P('').is_reserved())
1283 self.assertIs(False, P('/').is_reserved())
1284 self.assertIs(False, P('/foo/bar').is_reserved())
1285 self.assertIs(True, P('con').is_reserved())
1286 self.assertIs(True, P('NUL').is_reserved())
1287 self.assertIs(True, P('NUL.txt').is_reserved())
1288 self.assertIs(True, P('com1').is_reserved())
1289 self.assertIs(True, P('com9.bar').is_reserved())
1290 self.assertIs(False, P('bar.com9').is_reserved())
1291 self.assertIs(True, P('lpt1').is_reserved())
1292 self.assertIs(True, P('lpt9.bar').is_reserved())
1293 self.assertIs(False, P('bar.lpt9').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001294 # Only the last component matters.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001295 self.assertIs(False, P('c:/NUL/con/baz').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001296 # UNC paths are never reserved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001297 self.assertIs(False, P('//my/share/nul/con/aux').is_reserved())
1298
Antoine Pitrou31119e42013-11-22 17:38:12 +01001299class PurePathTest(_BasePurePathTest, unittest.TestCase):
1300 cls = pathlib.PurePath
1301
1302 def test_concrete_class(self):
1303 p = self.cls('a')
1304 self.assertIs(type(p),
1305 pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath)
1306
1307 def test_different_flavours_unequal(self):
1308 p = pathlib.PurePosixPath('a')
1309 q = pathlib.PureWindowsPath('a')
1310 self.assertNotEqual(p, q)
1311
1312 def test_different_flavours_unordered(self):
1313 p = pathlib.PurePosixPath('a')
1314 q = pathlib.PureWindowsPath('a')
1315 with self.assertRaises(TypeError):
1316 p < q
1317 with self.assertRaises(TypeError):
1318 p <= q
1319 with self.assertRaises(TypeError):
1320 p > q
1321 with self.assertRaises(TypeError):
1322 p >= q
1323
1324
1325#
Anthony Shaw83da9262019-01-07 07:31:29 +11001326# Tests for the concrete classes.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001327#
1328
Anthony Shaw83da9262019-01-07 07:31:29 +11001329# Make sure any symbolic links in the base test path are resolved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001330BASE = os.path.realpath(TESTFN)
1331join = lambda *x: os.path.join(BASE, *x)
1332rel_join = lambda *x: os.path.join(TESTFN, *x)
1333
Antoine Pitrou31119e42013-11-22 17:38:12 +01001334only_nt = unittest.skipIf(os.name != 'nt',
1335 'test requires a Windows-compatible system')
1336only_posix = unittest.skipIf(os.name == 'nt',
1337 'test requires a POSIX-compatible system')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001338
1339@only_posix
1340class PosixPathAsPureTest(PurePosixPathTest):
1341 cls = pathlib.PosixPath
1342
1343@only_nt
1344class WindowsPathAsPureTest(PureWindowsPathTest):
1345 cls = pathlib.WindowsPath
1346
Victor Stinnerd7569632016-03-11 22:53:00 +01001347 def test_owner(self):
1348 P = self.cls
1349 with self.assertRaises(NotImplementedError):
1350 P('c:/').owner()
1351
1352 def test_group(self):
1353 P = self.cls
1354 with self.assertRaises(NotImplementedError):
1355 P('c:/').group()
1356
Antoine Pitrou31119e42013-11-22 17:38:12 +01001357
1358class _BasePathTest(object):
1359 """Tests for the FS-accessing functionalities of the Path classes."""
1360
1361 # (BASE)
1362 # |
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001363 # |-- brokenLink -> non-existing
1364 # |-- dirA
1365 # | `-- linkC -> ../dirB
1366 # |-- dirB
1367 # | |-- fileB
1368 # | `-- linkD -> ../dirB
1369 # |-- dirC
1370 # | |-- dirD
1371 # | | `-- fileD
1372 # | `-- fileC
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001373 # |-- dirE # No permissions
Antoine Pitrou31119e42013-11-22 17:38:12 +01001374 # |-- fileA
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001375 # |-- linkA -> fileA
Jörg Stucked5c120f2019-05-21 19:44:40 +02001376 # |-- linkB -> dirB
1377 # `-- brokenLinkLoop -> brokenLinkLoop
Antoine Pitrou31119e42013-11-22 17:38:12 +01001378 #
1379
1380 def setUp(self):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001381 def cleanup():
1382 os.chmod(join('dirE'), 0o777)
Hai Shibb0424b2020-08-04 00:47:42 +08001383 os_helper.rmtree(BASE)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001384 self.addCleanup(cleanup)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001385 os.mkdir(BASE)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001386 os.mkdir(join('dirA'))
1387 os.mkdir(join('dirB'))
1388 os.mkdir(join('dirC'))
1389 os.mkdir(join('dirC', 'dirD'))
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001390 os.mkdir(join('dirE'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001391 with open(join('fileA'), 'wb') as f:
1392 f.write(b"this is file A\n")
1393 with open(join('dirB', 'fileB'), 'wb') as f:
1394 f.write(b"this is file B\n")
1395 with open(join('dirC', 'fileC'), 'wb') as f:
1396 f.write(b"this is file C\n")
1397 with open(join('dirC', 'dirD', 'fileD'), 'wb') as f:
1398 f.write(b"this is file D\n")
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001399 os.chmod(join('dirE'), 0)
Hai Shibb0424b2020-08-04 00:47:42 +08001400 if os_helper.can_symlink():
Anthony Shaw83da9262019-01-07 07:31:29 +11001401 # Relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001402 os.symlink('fileA', join('linkA'))
1403 os.symlink('non-existing', join('brokenLink'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001404 self.dirlink('dirB', join('linkB'))
1405 self.dirlink(os.path.join('..', 'dirB'), join('dirA', 'linkC'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001406 # This one goes upwards, creating a loop.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001407 self.dirlink(os.path.join('..', 'dirB'), join('dirB', 'linkD'))
Jörg Stucked5c120f2019-05-21 19:44:40 +02001408 # Broken symlink (pointing to itself).
1409 os.symlink('brokenLinkLoop', join('brokenLinkLoop'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001410
1411 if os.name == 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11001412 # Workaround for http://bugs.python.org/issue13772.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001413 def dirlink(self, src, dest):
1414 os.symlink(src, dest, target_is_directory=True)
1415 else:
1416 def dirlink(self, src, dest):
1417 os.symlink(src, dest)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001418
1419 def assertSame(self, path_a, path_b):
1420 self.assertTrue(os.path.samefile(str(path_a), str(path_b)),
1421 "%r and %r don't point to the same file" %
1422 (path_a, path_b))
1423
1424 def assertFileNotFound(self, func, *args, **kwargs):
1425 with self.assertRaises(FileNotFoundError) as cm:
1426 func(*args, **kwargs)
1427 self.assertEqual(cm.exception.errno, errno.ENOENT)
1428
Steve Dower97d79062019-09-10 14:52:48 +01001429 def assertEqualNormCase(self, path_a, path_b):
1430 self.assertEqual(os.path.normcase(path_a), os.path.normcase(path_b))
1431
Antoine Pitrou31119e42013-11-22 17:38:12 +01001432 def _test_cwd(self, p):
1433 q = self.cls(os.getcwd())
1434 self.assertEqual(p, q)
Steve Dower97d79062019-09-10 14:52:48 +01001435 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001436 self.assertIs(type(p), type(q))
1437 self.assertTrue(p.is_absolute())
1438
1439 def test_cwd(self):
1440 p = self.cls.cwd()
1441 self._test_cwd(p)
1442
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001443 def _test_home(self, p):
1444 q = self.cls(os.path.expanduser('~'))
1445 self.assertEqual(p, q)
Steve Dower97d79062019-09-10 14:52:48 +01001446 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001447 self.assertIs(type(p), type(q))
1448 self.assertTrue(p.is_absolute())
1449
1450 def test_home(self):
Hai Shibb0424b2020-08-04 00:47:42 +08001451 with os_helper.EnvironmentVarGuard() as env:
Christoph Reiterc45a2aa2020-01-28 10:41:50 +01001452 self._test_home(self.cls.home())
1453
1454 env.clear()
1455 env['USERPROFILE'] = os.path.join(BASE, 'userprofile')
1456 self._test_home(self.cls.home())
1457
1458 # bpo-38883: ignore `HOME` when set on windows
1459 env['HOME'] = os.path.join(BASE, 'home')
1460 self._test_home(self.cls.home())
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001461
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001462 def test_samefile(self):
1463 fileA_path = os.path.join(BASE, 'fileA')
1464 fileB_path = os.path.join(BASE, 'dirB', 'fileB')
1465 p = self.cls(fileA_path)
1466 pp = self.cls(fileA_path)
1467 q = self.cls(fileB_path)
1468 self.assertTrue(p.samefile(fileA_path))
1469 self.assertTrue(p.samefile(pp))
1470 self.assertFalse(p.samefile(fileB_path))
1471 self.assertFalse(p.samefile(q))
1472 # Test the non-existent file case
1473 non_existent = os.path.join(BASE, 'foo')
1474 r = self.cls(non_existent)
1475 self.assertRaises(FileNotFoundError, p.samefile, r)
1476 self.assertRaises(FileNotFoundError, p.samefile, non_existent)
1477 self.assertRaises(FileNotFoundError, r.samefile, p)
1478 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1479 self.assertRaises(FileNotFoundError, r.samefile, r)
1480 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1481
Antoine Pitrou31119e42013-11-22 17:38:12 +01001482 def test_empty_path(self):
1483 # The empty path points to '.'
1484 p = self.cls('')
1485 self.assertEqual(p.stat(), os.stat('.'))
1486
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001487 def test_expanduser_common(self):
1488 P = self.cls
1489 p = P('~')
1490 self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))
1491 p = P('foo')
1492 self.assertEqual(p.expanduser(), p)
1493 p = P('/~')
1494 self.assertEqual(p.expanduser(), p)
1495 p = P('../~')
1496 self.assertEqual(p.expanduser(), p)
1497 p = P(P('').absolute().anchor) / '~'
1498 self.assertEqual(p.expanduser(), p)
1499
Antoine Pitrou31119e42013-11-22 17:38:12 +01001500 def test_exists(self):
1501 P = self.cls
1502 p = P(BASE)
1503 self.assertIs(True, p.exists())
1504 self.assertIs(True, (p / 'dirA').exists())
1505 self.assertIs(True, (p / 'fileA').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001506 self.assertIs(False, (p / 'fileA' / 'bah').exists())
Hai Shibb0424b2020-08-04 00:47:42 +08001507 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001508 self.assertIs(True, (p / 'linkA').exists())
1509 self.assertIs(True, (p / 'linkB').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001510 self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1511 self.assertIs(False, (p / 'linkA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001512 self.assertIs(False, (p / 'foo').exists())
1513 self.assertIs(False, P('/xyzzy').exists())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001514 self.assertIs(False, P(BASE + '\udfff').exists())
1515 self.assertIs(False, P(BASE + '\x00').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001516
1517 def test_open_common(self):
1518 p = self.cls(BASE)
1519 with (p / 'fileA').open('r') as f:
1520 self.assertIsInstance(f, io.TextIOBase)
1521 self.assertEqual(f.read(), "this is file A\n")
1522 with (p / 'fileA').open('rb') as f:
1523 self.assertIsInstance(f, io.BufferedIOBase)
1524 self.assertEqual(f.read().strip(), b"this is file A")
1525 with (p / 'fileA').open('rb', buffering=0) as f:
1526 self.assertIsInstance(f, io.RawIOBase)
1527 self.assertEqual(f.read().strip(), b"this is file A")
1528
Georg Brandlea683982014-10-01 19:12:33 +02001529 def test_read_write_bytes(self):
1530 p = self.cls(BASE)
1531 (p / 'fileA').write_bytes(b'abcdefg')
1532 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001533 # Check that trying to write str does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001534 self.assertRaises(TypeError, (p / 'fileA').write_bytes, 'somestr')
1535 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1536
1537 def test_read_write_text(self):
1538 p = self.cls(BASE)
1539 (p / 'fileA').write_text('äbcdefg', encoding='latin-1')
1540 self.assertEqual((p / 'fileA').read_text(
1541 encoding='utf-8', errors='ignore'), 'bcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001542 # Check that trying to write bytes does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001543 self.assertRaises(TypeError, (p / 'fileA').write_text, b'somebytes')
1544 self.assertEqual((p / 'fileA').read_text(encoding='latin-1'), 'äbcdefg')
1545
Максим5f227412020-10-21 05:08:19 +03001546 def test_write_text_with_newlines(self):
1547 p = self.cls(BASE)
1548 # Check that `\n` character change nothing
1549 (p / 'fileA').write_text('abcde\r\nfghlk\n\rmnopq', newline='\n')
1550 self.assertEqual((p / 'fileA').read_bytes(),
1551 b'abcde\r\nfghlk\n\rmnopq')
1552 # Check that `\r` character replaces `\n`
1553 (p / 'fileA').write_text('abcde\r\nfghlk\n\rmnopq', newline='\r')
1554 self.assertEqual((p / 'fileA').read_bytes(),
1555 b'abcde\r\rfghlk\r\rmnopq')
1556 # Check that `\r\n` character replaces `\n`
1557 (p / 'fileA').write_text('abcde\r\nfghlk\n\rmnopq', newline='\r\n')
1558 self.assertEqual((p / 'fileA').read_bytes(),
1559 b'abcde\r\r\nfghlk\r\n\rmnopq')
1560 # Check that no argument passed will change `\n` to `os.linesep`
1561 os_linesep_byte = bytes(os.linesep, encoding='ascii')
1562 (p / 'fileA').write_text('abcde\nfghlk\n\rmnopq')
1563 self.assertEqual((p / 'fileA').read_bytes(),
1564 b'abcde' + os_linesep_byte + b'fghlk' + os_linesep_byte + b'\rmnopq')
1565
Antoine Pitrou31119e42013-11-22 17:38:12 +01001566 def test_iterdir(self):
1567 P = self.cls
1568 p = P(BASE)
1569 it = p.iterdir()
1570 paths = set(it)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001571 expected = ['dirA', 'dirB', 'dirC', 'dirE', 'fileA']
Hai Shibb0424b2020-08-04 00:47:42 +08001572 if os_helper.can_symlink():
Jörg Stucked5c120f2019-05-21 19:44:40 +02001573 expected += ['linkA', 'linkB', 'brokenLink', 'brokenLinkLoop']
Antoine Pitrou31119e42013-11-22 17:38:12 +01001574 self.assertEqual(paths, { P(BASE, q) for q in expected })
1575
Hai Shibb0424b2020-08-04 00:47:42 +08001576 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001577 def test_iterdir_symlink(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001578 # __iter__ on a symlink to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001579 P = self.cls
1580 p = P(BASE, 'linkB')
1581 paths = set(p.iterdir())
1582 expected = { P(BASE, 'linkB', q) for q in ['fileB', 'linkD'] }
1583 self.assertEqual(paths, expected)
1584
1585 def test_iterdir_nodir(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001586 # __iter__ on something that is not a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001587 p = self.cls(BASE, 'fileA')
1588 with self.assertRaises(OSError) as cm:
1589 next(p.iterdir())
1590 # ENOENT or EINVAL under Windows, ENOTDIR otherwise
Anthony Shaw83da9262019-01-07 07:31:29 +11001591 # (see issue #12802).
Antoine Pitrou31119e42013-11-22 17:38:12 +01001592 self.assertIn(cm.exception.errno, (errno.ENOTDIR,
1593 errno.ENOENT, errno.EINVAL))
1594
1595 def test_glob_common(self):
1596 def _check(glob, expected):
1597 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1598 P = self.cls
1599 p = P(BASE)
1600 it = p.glob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001601 self.assertIsInstance(it, collections.abc.Iterator)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001602 _check(it, ["fileA"])
1603 _check(p.glob("fileB"), [])
1604 _check(p.glob("dir*/file*"), ["dirB/fileB", "dirC/fileC"])
Hai Shibb0424b2020-08-04 00:47:42 +08001605 if not os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001606 _check(p.glob("*A"), ['dirA', 'fileA'])
1607 else:
1608 _check(p.glob("*A"), ['dirA', 'fileA', 'linkA'])
Hai Shibb0424b2020-08-04 00:47:42 +08001609 if not os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001610 _check(p.glob("*B/*"), ['dirB/fileB'])
1611 else:
1612 _check(p.glob("*B/*"), ['dirB/fileB', 'dirB/linkD',
1613 'linkB/fileB', 'linkB/linkD'])
Hai Shibb0424b2020-08-04 00:47:42 +08001614 if not os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001615 _check(p.glob("*/fileB"), ['dirB/fileB'])
1616 else:
1617 _check(p.glob("*/fileB"), ['dirB/fileB', 'linkB/fileB'])
1618
1619 def test_rglob_common(self):
1620 def _check(glob, expected):
1621 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1622 P = self.cls
1623 p = P(BASE)
1624 it = p.rglob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001625 self.assertIsInstance(it, collections.abc.Iterator)
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001626 _check(it, ["fileA"])
1627 _check(p.rglob("fileB"), ["dirB/fileB"])
1628 _check(p.rglob("*/fileA"), [])
Hai Shibb0424b2020-08-04 00:47:42 +08001629 if not os_helper.can_symlink():
Guido van Rossum9c39b672016-01-07 13:12:34 -08001630 _check(p.rglob("*/fileB"), ["dirB/fileB"])
1631 else:
1632 _check(p.rglob("*/fileB"), ["dirB/fileB", "dirB/linkD/fileB",
1633 "linkB/fileB", "dirA/linkC/fileB"])
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001634 _check(p.rglob("file*"), ["fileA", "dirB/fileB",
1635 "dirC/fileC", "dirC/dirD/fileD"])
Antoine Pitrou31119e42013-11-22 17:38:12 +01001636 p = P(BASE, "dirC")
1637 _check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
1638 _check(p.rglob("*/*"), ["dirC/dirD/fileD"])
1639
Hai Shibb0424b2020-08-04 00:47:42 +08001640 @os_helper.skip_unless_symlink
Guido van Rossum69bfb152016-01-06 10:31:33 -08001641 def test_rglob_symlink_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001642 # Don't get fooled by symlink loops (Issue #26012).
Guido van Rossum69bfb152016-01-06 10:31:33 -08001643 P = self.cls
1644 p = P(BASE)
1645 given = set(p.rglob('*'))
1646 expect = {'brokenLink',
1647 'dirA', 'dirA/linkC',
1648 'dirB', 'dirB/fileB', 'dirB/linkD',
1649 'dirC', 'dirC/dirD', 'dirC/dirD/fileD', 'dirC/fileC',
1650 'dirE',
1651 'fileA',
1652 'linkA',
1653 'linkB',
Jörg Stucked5c120f2019-05-21 19:44:40 +02001654 'brokenLinkLoop',
Guido van Rossum69bfb152016-01-06 10:31:33 -08001655 }
1656 self.assertEqual(given, {p / x for x in expect})
1657
Serhiy Storchakaf9dc2ad2019-09-12 15:54:48 +03001658 def test_glob_many_open_files(self):
1659 depth = 30
1660 P = self.cls
1661 base = P(BASE) / 'deep'
1662 p = P(base, *(['d']*depth))
1663 p.mkdir(parents=True)
1664 pattern = '/'.join(['*'] * depth)
1665 iters = [base.glob(pattern) for j in range(100)]
1666 for it in iters:
1667 self.assertEqual(next(it), p)
1668 iters = [base.rglob('d') for j in range(100)]
1669 p = base
1670 for i in range(depth):
1671 p = p / 'd'
1672 for it in iters:
1673 self.assertEqual(next(it), p)
1674
Antoine Pitrou31119e42013-11-22 17:38:12 +01001675 def test_glob_dotdot(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001676 # ".." is not special in globs.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001677 P = self.cls
1678 p = P(BASE)
1679 self.assertEqual(set(p.glob("..")), { P(BASE, "..") })
1680 self.assertEqual(set(p.glob("dirA/../file*")), { P(BASE, "dirA/../fileA") })
1681 self.assertEqual(set(p.glob("../xyzzy")), set())
1682
Hai Shibb0424b2020-08-04 00:47:42 +08001683 @os_helper.skip_unless_symlink
Pablo Galindoeb7560a2020-03-07 17:53:20 +00001684 def test_glob_permissions(self):
1685 # See bpo-38894
1686 P = self.cls
1687 base = P(BASE) / 'permissions'
1688 base.mkdir()
1689
1690 file1 = base / "file1"
1691 file1.touch()
1692 file2 = base / "file2"
1693 file2.touch()
1694
1695 subdir = base / "subdir"
1696
1697 file3 = base / "file3"
1698 file3.symlink_to(subdir / "other")
1699
1700 # Patching is needed to avoid relying on the filesystem
1701 # to return the order of the files as the error will not
1702 # happen if the symlink is the last item.
1703
1704 with mock.patch("os.scandir") as scandir:
1705 scandir.return_value = sorted(os.scandir(base))
1706 self.assertEqual(len(set(base.glob("*"))), 3)
1707
1708 subdir.mkdir()
1709
1710 with mock.patch("os.scandir") as scandir:
1711 scandir.return_value = sorted(os.scandir(base))
1712 self.assertEqual(len(set(base.glob("*"))), 4)
1713
1714 subdir.chmod(000)
1715
1716 with mock.patch("os.scandir") as scandir:
1717 scandir.return_value = sorted(os.scandir(base))
1718 self.assertEqual(len(set(base.glob("*"))), 4)
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001719
Steve Dower98eb3602016-11-09 12:58:17 -08001720 def _check_resolve(self, p, expected, strict=True):
1721 q = p.resolve(strict)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001722 self.assertEqual(q, expected)
1723
Anthony Shaw83da9262019-01-07 07:31:29 +11001724 # This can be used to check both relative and absolute resolutions.
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001725 _check_resolve_relative = _check_resolve_absolute = _check_resolve
Antoine Pitrou31119e42013-11-22 17:38:12 +01001726
Hai Shibb0424b2020-08-04 00:47:42 +08001727 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001728 def test_resolve_common(self):
1729 P = self.cls
1730 p = P(BASE, 'foo')
1731 with self.assertRaises(OSError) as cm:
Steve Dower98eb3602016-11-09 12:58:17 -08001732 p.resolve(strict=True)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001733 self.assertEqual(cm.exception.errno, errno.ENOENT)
Steve Dower98eb3602016-11-09 12:58:17 -08001734 # Non-strict
Steve Dower97d79062019-09-10 14:52:48 +01001735 self.assertEqualNormCase(str(p.resolve(strict=False)),
1736 os.path.join(BASE, 'foo'))
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.join(BASE, 'foo', 'in', 'spam'))
Steve Dower98eb3602016-11-09 12:58:17 -08001740 p = P(BASE, '..', 'foo', 'in', 'spam')
Steve Dower97d79062019-09-10 14:52:48 +01001741 self.assertEqualNormCase(str(p.resolve(strict=False)),
1742 os.path.abspath(os.path.join('foo', 'in', 'spam')))
Anthony Shaw83da9262019-01-07 07:31:29 +11001743 # These are all relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001744 p = P(BASE, 'dirB', 'fileB')
1745 self._check_resolve_relative(p, p)
1746 p = P(BASE, 'linkA')
1747 self._check_resolve_relative(p, P(BASE, 'fileA'))
1748 p = P(BASE, 'dirA', 'linkC', 'fileB')
1749 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1750 p = P(BASE, 'dirB', 'linkD', 'fileB')
1751 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001752 # Non-strict
1753 p = P(BASE, 'dirA', 'linkC', 'fileB', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001754 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB', 'foo', 'in',
1755 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001756 p = P(BASE, 'dirA', 'linkC', '..', 'foo', 'in', 'spam')
1757 if os.name == 'nt':
1758 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1759 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001760 self._check_resolve_relative(p, P(BASE, 'dirA', 'foo', 'in',
1761 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001762 else:
1763 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1764 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001765 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Anthony Shaw83da9262019-01-07 07:31:29 +11001766 # Now create absolute symlinks.
Hai Shibb0424b2020-08-04 00:47:42 +08001767 d = os_helper._longpath(tempfile.mkdtemp(suffix='-dirD',
1768 dir=os.getcwd()))
1769 self.addCleanup(os_helper.rmtree, d)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001770 os.symlink(os.path.join(d), join('dirA', 'linkX'))
1771 os.symlink(join('dirB'), os.path.join(d, 'linkY'))
1772 p = P(BASE, 'dirA', 'linkX', 'linkY', 'fileB')
1773 self._check_resolve_absolute(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001774 # Non-strict
1775 p = P(BASE, 'dirA', 'linkX', 'linkY', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001776 self._check_resolve_relative(p, P(BASE, 'dirB', 'foo', 'in', 'spam'),
1777 False)
Steve Dower98eb3602016-11-09 12:58:17 -08001778 p = P(BASE, 'dirA', 'linkX', 'linkY', '..', 'foo', 'in', 'spam')
1779 if os.name == 'nt':
1780 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1781 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001782 self._check_resolve_relative(p, P(d, 'foo', 'in', 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001783 else:
1784 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1785 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001786 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001787
Hai Shibb0424b2020-08-04 00:47:42 +08001788 @os_helper.skip_unless_symlink
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001789 def test_resolve_dot(self):
1790 # See https://bitbucket.org/pitrou/pathlib/issue/9/pathresolve-fails-on-complex-symlinks
1791 p = self.cls(BASE)
1792 self.dirlink('.', join('0'))
Antoine Pitroucc157512013-12-03 17:13:13 +01001793 self.dirlink(os.path.join('0', '0'), join('1'))
1794 self.dirlink(os.path.join('1', '1'), join('2'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001795 q = p / '2'
Steve Dower98eb3602016-11-09 12:58:17 -08001796 self.assertEqual(q.resolve(strict=True), p)
1797 r = q / '3' / '4'
1798 self.assertRaises(FileNotFoundError, r.resolve, strict=True)
1799 # Non-strict
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001800 self.assertEqual(r.resolve(strict=False), p / '3' / '4')
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001801
Barney Galeee51c562021-05-21 12:54:56 +01001802 def test_resolve_nonexist_relative_issue38671(self):
1803 p = self.cls('non', 'exist')
1804
1805 old_cwd = os.getcwd()
1806 os.chdir(BASE)
1807 try:
1808 self.assertEqual(p.resolve(), self.cls(BASE, p))
1809 finally:
1810 os.chdir(old_cwd)
1811
Antoine Pitrou31119e42013-11-22 17:38:12 +01001812 def test_with(self):
1813 p = self.cls(BASE)
1814 it = p.iterdir()
1815 it2 = p.iterdir()
1816 next(it2)
1817 with p:
1818 pass
Barney Gale00002e62020-04-01 15:10:51 +01001819 # Using a path as a context manager is a no-op, thus the following
1820 # operations should still succeed after the context manage exits.
1821 next(it)
1822 next(it2)
1823 p.exists()
1824 p.resolve()
1825 p.absolute()
1826 with p:
1827 pass
Antoine Pitrou31119e42013-11-22 17:38:12 +01001828
1829 def test_chmod(self):
1830 p = self.cls(BASE) / 'fileA'
1831 mode = p.stat().st_mode
Anthony Shaw83da9262019-01-07 07:31:29 +11001832 # Clear writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001833 new_mode = mode & ~0o222
1834 p.chmod(new_mode)
1835 self.assertEqual(p.stat().st_mode, new_mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11001836 # Set writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001837 new_mode = mode | 0o222
1838 p.chmod(new_mode)
1839 self.assertEqual(p.stat().st_mode, new_mode)
1840
Barney Galeabf96492021-04-07 16:53:39 +01001841 # On Windows, os.chmod does not follow symlinks (issue #15411)
1842 @only_posix
1843 def test_chmod_follow_symlinks_true(self):
1844 p = self.cls(BASE) / 'linkA'
1845 q = p.resolve()
1846 mode = q.stat().st_mode
1847 # Clear writable bit.
1848 new_mode = mode & ~0o222
1849 p.chmod(new_mode, follow_symlinks=True)
1850 self.assertEqual(q.stat().st_mode, new_mode)
1851 # Set writable bit
1852 new_mode = mode | 0o222
1853 p.chmod(new_mode, follow_symlinks=True)
1854 self.assertEqual(q.stat().st_mode, new_mode)
1855
Anthony Shaw83da9262019-01-07 07:31:29 +11001856 # XXX also need a test for lchmod.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001857
1858 def test_stat(self):
1859 p = self.cls(BASE) / 'fileA'
1860 st = p.stat()
1861 self.assertEqual(p.stat(), st)
Anthony Shaw83da9262019-01-07 07:31:29 +11001862 # Change file mode by flipping write bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001863 p.chmod(st.st_mode ^ 0o222)
1864 self.addCleanup(p.chmod, st.st_mode)
1865 self.assertNotEqual(p.stat(), st)
1866
Hai Shibb0424b2020-08-04 00:47:42 +08001867 @os_helper.skip_unless_symlink
Barney Galeabf96492021-04-07 16:53:39 +01001868 def test_stat_no_follow_symlinks(self):
1869 p = self.cls(BASE) / 'linkA'
1870 st = p.stat()
1871 self.assertNotEqual(st, p.stat(follow_symlinks=False))
1872
1873 def test_stat_no_follow_symlinks_nosymlink(self):
1874 p = self.cls(BASE) / 'fileA'
1875 st = p.stat()
1876 self.assertEqual(st, p.stat(follow_symlinks=False))
1877
1878 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001879 def test_lstat(self):
1880 p = self.cls(BASE)/ 'linkA'
1881 st = p.stat()
1882 self.assertNotEqual(st, p.lstat())
1883
1884 def test_lstat_nosymlink(self):
1885 p = self.cls(BASE) / 'fileA'
1886 st = p.stat()
1887 self.assertEqual(st, p.lstat())
1888
1889 @unittest.skipUnless(pwd, "the pwd module is needed for this test")
1890 def test_owner(self):
1891 p = self.cls(BASE) / 'fileA'
1892 uid = p.stat().st_uid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001893 try:
1894 name = pwd.getpwuid(uid).pw_name
1895 except KeyError:
1896 self.skipTest(
1897 "user %d doesn't have an entry in the system database" % uid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001898 self.assertEqual(name, p.owner())
1899
1900 @unittest.skipUnless(grp, "the grp module is needed for this test")
1901 def test_group(self):
1902 p = self.cls(BASE) / 'fileA'
1903 gid = p.stat().st_gid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001904 try:
1905 name = grp.getgrgid(gid).gr_name
1906 except KeyError:
1907 self.skipTest(
1908 "group %d doesn't have an entry in the system database" % gid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001909 self.assertEqual(name, p.group())
1910
1911 def test_unlink(self):
1912 p = self.cls(BASE) / 'fileA'
1913 p.unlink()
1914 self.assertFileNotFound(p.stat)
1915 self.assertFileNotFound(p.unlink)
1916
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001917 def test_unlink_missing_ok(self):
1918 p = self.cls(BASE) / 'fileAAA'
1919 self.assertFileNotFound(p.unlink)
1920 p.unlink(missing_ok=True)
1921
Antoine Pitrou31119e42013-11-22 17:38:12 +01001922 def test_rmdir(self):
1923 p = self.cls(BASE) / 'dirA'
1924 for q in p.iterdir():
1925 q.unlink()
1926 p.rmdir()
1927 self.assertFileNotFound(p.stat)
1928 self.assertFileNotFound(p.unlink)
1929
Toke Høiland-Jørgensen092435e2019-12-16 13:23:55 +01001930 @unittest.skipUnless(hasattr(os, "link"), "os.link() is not present")
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001931 def test_link_to(self):
1932 P = self.cls(BASE)
1933 p = P / 'fileA'
1934 size = p.stat().st_size
1935 # linking to another path.
1936 q = P / 'dirA' / 'fileAA'
1937 try:
Barney Galef24e2e52021-04-23 21:48:52 +01001938 with self.assertWarns(DeprecationWarning):
1939 p.link_to(q)
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001940 except PermissionError as e:
1941 self.skipTest('os.link(): %s' % e)
1942 self.assertEqual(q.stat().st_size, size)
1943 self.assertEqual(os.path.samefile(p, q), True)
1944 self.assertTrue(p.stat)
1945 # Linking to a str of a relative path.
1946 r = rel_join('fileAAA')
Miss Islington (bot)b913f472021-05-16 15:35:44 -07001947 with self.assertWarns(DeprecationWarning):
1948 q.link_to(r)
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001949 self.assertEqual(os.stat(r).st_size, size)
1950 self.assertTrue(q.stat)
1951
Barney Galef24e2e52021-04-23 21:48:52 +01001952 @unittest.skipUnless(hasattr(os, "link"), "os.link() is not present")
1953 def test_hardlink_to(self):
1954 P = self.cls(BASE)
1955 target = P / 'fileA'
1956 size = target.stat().st_size
1957 # linking to another path.
1958 link = P / 'dirA' / 'fileAA'
1959 link.hardlink_to(target)
1960 self.assertEqual(link.stat().st_size, size)
1961 self.assertTrue(os.path.samefile(target, link))
1962 self.assertTrue(target.exists())
1963 # Linking to a str of a relative path.
1964 link2 = P / 'dirA' / 'fileAAA'
1965 target2 = rel_join('fileA')
1966 link2.hardlink_to(target2)
1967 self.assertEqual(os.stat(target2).st_size, size)
1968 self.assertTrue(link2.exists())
1969
Toke Høiland-Jørgensen092435e2019-12-16 13:23:55 +01001970 @unittest.skipIf(hasattr(os, "link"), "os.link() is present")
1971 def test_link_to_not_implemented(self):
1972 P = self.cls(BASE)
1973 p = P / 'fileA'
1974 # linking to another path.
1975 q = P / 'dirA' / 'fileAA'
1976 with self.assertRaises(NotImplementedError):
1977 p.link_to(q)
1978
Antoine Pitrou31119e42013-11-22 17:38:12 +01001979 def test_rename(self):
1980 P = self.cls(BASE)
1981 p = P / 'fileA'
1982 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11001983 # Renaming to another path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001984 q = P / 'dirA' / 'fileAA'
hui shang088a09a2019-09-11 21:26:49 +08001985 renamed_p = p.rename(q)
1986 self.assertEqual(renamed_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001987 self.assertEqual(q.stat().st_size, size)
1988 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11001989 # Renaming to a str of a relative path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001990 r = rel_join('fileAAA')
hui shang088a09a2019-09-11 21:26:49 +08001991 renamed_q = q.rename(r)
1992 self.assertEqual(renamed_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001993 self.assertEqual(os.stat(r).st_size, size)
1994 self.assertFileNotFound(q.stat)
1995
1996 def test_replace(self):
1997 P = self.cls(BASE)
1998 p = P / 'fileA'
1999 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11002000 # Replacing a non-existing path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002001 q = P / 'dirA' / 'fileAA'
hui shang088a09a2019-09-11 21:26:49 +08002002 replaced_p = p.replace(q)
2003 self.assertEqual(replaced_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002004 self.assertEqual(q.stat().st_size, size)
2005 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11002006 # Replacing another (existing) path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002007 r = rel_join('dirB', 'fileB')
hui shang088a09a2019-09-11 21:26:49 +08002008 replaced_q = q.replace(r)
2009 self.assertEqual(replaced_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002010 self.assertEqual(os.stat(r).st_size, size)
2011 self.assertFileNotFound(q.stat)
2012
Hai Shibb0424b2020-08-04 00:47:42 +08002013 @os_helper.skip_unless_symlink
Girtsa01ba332019-10-23 14:18:40 -07002014 def test_readlink(self):
2015 P = self.cls(BASE)
2016 self.assertEqual((P / 'linkA').readlink(), self.cls('fileA'))
2017 self.assertEqual((P / 'brokenLink').readlink(),
2018 self.cls('non-existing'))
2019 self.assertEqual((P / 'linkB').readlink(), self.cls('dirB'))
2020 with self.assertRaises(OSError):
2021 (P / 'fileA').readlink()
2022
Antoine Pitrou31119e42013-11-22 17:38:12 +01002023 def test_touch_common(self):
2024 P = self.cls(BASE)
2025 p = P / 'newfileA'
2026 self.assertFalse(p.exists())
2027 p.touch()
2028 self.assertTrue(p.exists())
Antoine Pitrou0f575642013-11-22 23:20:08 +01002029 st = p.stat()
2030 old_mtime = st.st_mtime
2031 old_mtime_ns = st.st_mtime_ns
Antoine Pitrou31119e42013-11-22 17:38:12 +01002032 # Rewind the mtime sufficiently far in the past to work around
2033 # filesystem-specific timestamp granularity.
2034 os.utime(str(p), (old_mtime - 10, old_mtime - 10))
Anthony Shaw83da9262019-01-07 07:31:29 +11002035 # The file mtime should be refreshed by calling touch() again.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002036 p.touch()
Antoine Pitrou0f575642013-11-22 23:20:08 +01002037 st = p.stat()
Antoine Pitrou2cf39172013-11-23 15:25:59 +01002038 self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)
2039 self.assertGreaterEqual(st.st_mtime, old_mtime)
Anthony Shaw83da9262019-01-07 07:31:29 +11002040 # Now with exist_ok=False.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002041 p = P / 'newfileB'
2042 self.assertFalse(p.exists())
2043 p.touch(mode=0o700, exist_ok=False)
2044 self.assertTrue(p.exists())
2045 self.assertRaises(OSError, p.touch, exist_ok=False)
2046
Antoine Pitrou8b784932013-11-23 14:52:39 +01002047 def test_touch_nochange(self):
2048 P = self.cls(BASE)
2049 p = P / 'fileA'
2050 p.touch()
2051 with p.open('rb') as f:
2052 self.assertEqual(f.read().strip(), b"this is file A")
2053
Antoine Pitrou31119e42013-11-22 17:38:12 +01002054 def test_mkdir(self):
2055 P = self.cls(BASE)
2056 p = P / 'newdirA'
2057 self.assertFalse(p.exists())
2058 p.mkdir()
2059 self.assertTrue(p.exists())
2060 self.assertTrue(p.is_dir())
2061 with self.assertRaises(OSError) as cm:
2062 p.mkdir()
2063 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002064
2065 def test_mkdir_parents(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002066 # Creating a chain of directories.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002067 p = self.cls(BASE, 'newdirB', 'newdirC')
2068 self.assertFalse(p.exists())
2069 with self.assertRaises(OSError) as cm:
2070 p.mkdir()
2071 self.assertEqual(cm.exception.errno, errno.ENOENT)
2072 p.mkdir(parents=True)
2073 self.assertTrue(p.exists())
2074 self.assertTrue(p.is_dir())
2075 with self.assertRaises(OSError) as cm:
2076 p.mkdir(parents=True)
2077 self.assertEqual(cm.exception.errno, errno.EEXIST)
Anthony Shaw83da9262019-01-07 07:31:29 +11002078 # Test `mode` arg.
2079 mode = stat.S_IMODE(p.stat().st_mode) # Default mode.
Antoine Pitrou0048c982013-12-16 20:22:37 +01002080 p = self.cls(BASE, 'newdirD', 'newdirE')
2081 p.mkdir(0o555, parents=True)
2082 self.assertTrue(p.exists())
2083 self.assertTrue(p.is_dir())
2084 if os.name != 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11002085 # The directory's permissions follow the mode argument.
Gregory P. Smithb599c612014-01-20 01:10:33 -08002086 self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11002087 # The parent's permissions follow the default process settings.
Antoine Pitrou0048c982013-12-16 20:22:37 +01002088 self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002089
Barry Warsaw7c549c42014-08-05 11:28:12 -04002090 def test_mkdir_exist_ok(self):
2091 p = self.cls(BASE, 'dirB')
2092 st_ctime_first = p.stat().st_ctime
2093 self.assertTrue(p.exists())
2094 self.assertTrue(p.is_dir())
2095 with self.assertRaises(FileExistsError) as cm:
2096 p.mkdir()
2097 self.assertEqual(cm.exception.errno, errno.EEXIST)
2098 p.mkdir(exist_ok=True)
2099 self.assertTrue(p.exists())
2100 self.assertEqual(p.stat().st_ctime, st_ctime_first)
2101
2102 def test_mkdir_exist_ok_with_parent(self):
2103 p = self.cls(BASE, 'dirC')
2104 self.assertTrue(p.exists())
2105 with self.assertRaises(FileExistsError) as cm:
2106 p.mkdir()
2107 self.assertEqual(cm.exception.errno, errno.EEXIST)
2108 p = p / 'newdirC'
2109 p.mkdir(parents=True)
2110 st_ctime_first = p.stat().st_ctime
2111 self.assertTrue(p.exists())
2112 with self.assertRaises(FileExistsError) as cm:
2113 p.mkdir(parents=True)
2114 self.assertEqual(cm.exception.errno, errno.EEXIST)
2115 p.mkdir(parents=True, exist_ok=True)
2116 self.assertTrue(p.exists())
2117 self.assertEqual(p.stat().st_ctime, st_ctime_first)
2118
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02002119 def test_mkdir_exist_ok_root(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002120 # Issue #25803: A drive root could raise PermissionError on Windows.
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02002121 self.cls('/').resolve().mkdir(exist_ok=True)
2122 self.cls('/').resolve().mkdir(parents=True, exist_ok=True)
2123
Anthony Shaw83da9262019-01-07 07:31:29 +11002124 @only_nt # XXX: not sure how to test this on POSIX.
Steve Dowerd3c48532017-02-04 14:54:56 -08002125 def test_mkdir_with_unknown_drive(self):
2126 for d in 'ZYXWVUTSRQPONMLKJIHGFEDCBA':
2127 p = self.cls(d + ':\\')
2128 if not p.is_dir():
2129 break
2130 else:
2131 self.skipTest("cannot find a drive that doesn't exist")
2132 with self.assertRaises(OSError):
2133 (p / 'child' / 'path').mkdir(parents=True)
2134
Barry Warsaw7c549c42014-08-05 11:28:12 -04002135 def test_mkdir_with_child_file(self):
2136 p = self.cls(BASE, 'dirB', 'fileB')
2137 self.assertTrue(p.exists())
2138 # An exception is raised when the last path component is an existing
2139 # regular file, regardless of whether exist_ok is true or not.
2140 with self.assertRaises(FileExistsError) as cm:
2141 p.mkdir(parents=True)
2142 self.assertEqual(cm.exception.errno, errno.EEXIST)
2143 with self.assertRaises(FileExistsError) as cm:
2144 p.mkdir(parents=True, exist_ok=True)
2145 self.assertEqual(cm.exception.errno, errno.EEXIST)
2146
2147 def test_mkdir_no_parents_file(self):
2148 p = self.cls(BASE, 'fileA')
2149 self.assertTrue(p.exists())
2150 # An exception is raised when the last path component is an existing
2151 # regular file, regardless of whether exist_ok is true or not.
2152 with self.assertRaises(FileExistsError) as cm:
2153 p.mkdir()
2154 self.assertEqual(cm.exception.errno, errno.EEXIST)
2155 with self.assertRaises(FileExistsError) as cm:
2156 p.mkdir(exist_ok=True)
2157 self.assertEqual(cm.exception.errno, errno.EEXIST)
2158
Armin Rigo22a594a2017-04-13 20:08:15 +02002159 def test_mkdir_concurrent_parent_creation(self):
2160 for pattern_num in range(32):
2161 p = self.cls(BASE, 'dirCPC%d' % pattern_num)
2162 self.assertFalse(p.exists())
2163
2164 def my_mkdir(path, mode=0o777):
2165 path = str(path)
2166 # Emulate another process that would create the directory
2167 # just before we try to create it ourselves. We do it
2168 # in all possible pattern combinations, assuming that this
2169 # function is called at most 5 times (dirCPC/dir1/dir2,
2170 # dirCPC/dir1, dirCPC, dirCPC/dir1, dirCPC/dir1/dir2).
2171 if pattern.pop():
Anthony Shaw83da9262019-01-07 07:31:29 +11002172 os.mkdir(path, mode) # From another process.
Armin Rigo22a594a2017-04-13 20:08:15 +02002173 concurrently_created.add(path)
Anthony Shaw83da9262019-01-07 07:31:29 +11002174 os.mkdir(path, mode) # Our real call.
Armin Rigo22a594a2017-04-13 20:08:15 +02002175
2176 pattern = [bool(pattern_num & (1 << n)) for n in range(5)]
2177 concurrently_created = set()
2178 p12 = p / 'dir1' / 'dir2'
2179 try:
2180 with mock.patch("pathlib._normal_accessor.mkdir", my_mkdir):
2181 p12.mkdir(parents=True, exist_ok=False)
2182 except FileExistsError:
2183 self.assertIn(str(p12), concurrently_created)
2184 else:
2185 self.assertNotIn(str(p12), concurrently_created)
2186 self.assertTrue(p.exists())
2187
Hai Shibb0424b2020-08-04 00:47:42 +08002188 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01002189 def test_symlink_to(self):
2190 P = self.cls(BASE)
2191 target = P / 'fileA'
Anthony Shaw83da9262019-01-07 07:31:29 +11002192 # Symlinking a path target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002193 link = P / 'dirA' / 'linkAA'
2194 link.symlink_to(target)
2195 self.assertEqual(link.stat(), target.stat())
2196 self.assertNotEqual(link.lstat(), target.stat())
Anthony Shaw83da9262019-01-07 07:31:29 +11002197 # Symlinking a str target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002198 link = P / 'dirA' / 'linkAAA'
2199 link.symlink_to(str(target))
2200 self.assertEqual(link.stat(), target.stat())
2201 self.assertNotEqual(link.lstat(), target.stat())
2202 self.assertFalse(link.is_dir())
Anthony Shaw83da9262019-01-07 07:31:29 +11002203 # Symlinking to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002204 target = P / 'dirB'
2205 link = P / 'dirA' / 'linkAAAA'
2206 link.symlink_to(target, target_is_directory=True)
2207 self.assertEqual(link.stat(), target.stat())
2208 self.assertNotEqual(link.lstat(), target.stat())
2209 self.assertTrue(link.is_dir())
2210 self.assertTrue(list(link.iterdir()))
2211
2212 def test_is_dir(self):
2213 P = self.cls(BASE)
2214 self.assertTrue((P / 'dirA').is_dir())
2215 self.assertFalse((P / 'fileA').is_dir())
2216 self.assertFalse((P / 'non-existing').is_dir())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002217 self.assertFalse((P / 'fileA' / 'bah').is_dir())
Hai Shibb0424b2020-08-04 00:47:42 +08002218 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002219 self.assertFalse((P / 'linkA').is_dir())
2220 self.assertTrue((P / 'linkB').is_dir())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002221 self.assertFalse((P/ 'brokenLink').is_dir(), False)
2222 self.assertIs((P / 'dirA\udfff').is_dir(), False)
2223 self.assertIs((P / 'dirA\x00').is_dir(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002224
2225 def test_is_file(self):
2226 P = self.cls(BASE)
2227 self.assertTrue((P / 'fileA').is_file())
2228 self.assertFalse((P / 'dirA').is_file())
2229 self.assertFalse((P / 'non-existing').is_file())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002230 self.assertFalse((P / 'fileA' / 'bah').is_file())
Hai Shibb0424b2020-08-04 00:47:42 +08002231 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002232 self.assertTrue((P / 'linkA').is_file())
2233 self.assertFalse((P / 'linkB').is_file())
2234 self.assertFalse((P/ 'brokenLink').is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002235 self.assertIs((P / 'fileA\udfff').is_file(), False)
2236 self.assertIs((P / 'fileA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002237
Cooper Lees173ff4a2017-08-01 15:35:45 -07002238 @only_posix
2239 def test_is_mount(self):
2240 P = self.cls(BASE)
Anthony Shaw83da9262019-01-07 07:31:29 +11002241 R = self.cls('/') # TODO: Work out Windows.
Cooper Lees173ff4a2017-08-01 15:35:45 -07002242 self.assertFalse((P / 'fileA').is_mount())
2243 self.assertFalse((P / 'dirA').is_mount())
2244 self.assertFalse((P / 'non-existing').is_mount())
2245 self.assertFalse((P / 'fileA' / 'bah').is_mount())
2246 self.assertTrue(R.is_mount())
Hai Shibb0424b2020-08-04 00:47:42 +08002247 if os_helper.can_symlink():
Cooper Lees173ff4a2017-08-01 15:35:45 -07002248 self.assertFalse((P / 'linkA').is_mount())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002249 self.assertIs(self.cls('/\udfff').is_mount(), False)
2250 self.assertIs(self.cls('/\x00').is_mount(), False)
Cooper Lees173ff4a2017-08-01 15:35:45 -07002251
Antoine Pitrou31119e42013-11-22 17:38:12 +01002252 def test_is_symlink(self):
2253 P = self.cls(BASE)
2254 self.assertFalse((P / 'fileA').is_symlink())
2255 self.assertFalse((P / 'dirA').is_symlink())
2256 self.assertFalse((P / 'non-existing').is_symlink())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002257 self.assertFalse((P / 'fileA' / 'bah').is_symlink())
Hai Shibb0424b2020-08-04 00:47:42 +08002258 if os_helper.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01002259 self.assertTrue((P / 'linkA').is_symlink())
2260 self.assertTrue((P / 'linkB').is_symlink())
2261 self.assertTrue((P/ 'brokenLink').is_symlink())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002262 self.assertIs((P / 'fileA\udfff').is_file(), False)
2263 self.assertIs((P / 'fileA\x00').is_file(), False)
Hai Shibb0424b2020-08-04 00:47:42 +08002264 if os_helper.can_symlink():
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002265 self.assertIs((P / 'linkA\udfff').is_file(), False)
2266 self.assertIs((P / 'linkA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002267
2268 def test_is_fifo_false(self):
2269 P = self.cls(BASE)
2270 self.assertFalse((P / 'fileA').is_fifo())
2271 self.assertFalse((P / 'dirA').is_fifo())
2272 self.assertFalse((P / 'non-existing').is_fifo())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002273 self.assertFalse((P / 'fileA' / 'bah').is_fifo())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002274 self.assertIs((P / 'fileA\udfff').is_fifo(), False)
2275 self.assertIs((P / 'fileA\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002276
2277 @unittest.skipUnless(hasattr(os, "mkfifo"), "os.mkfifo() required")
pxinwr6a273fd2020-11-29 06:06:36 +08002278 @unittest.skipIf(sys.platform == "vxworks",
2279 "fifo requires special path on VxWorks")
Antoine Pitrou31119e42013-11-22 17:38:12 +01002280 def test_is_fifo_true(self):
2281 P = self.cls(BASE, 'myfifo')
xdegaye92c2ca72017-11-12 17:31:07 +01002282 try:
2283 os.mkfifo(str(P))
2284 except PermissionError as e:
2285 self.skipTest('os.mkfifo(): %s' % e)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002286 self.assertTrue(P.is_fifo())
2287 self.assertFalse(P.is_socket())
2288 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002289 self.assertIs(self.cls(BASE, 'myfifo\udfff').is_fifo(), False)
2290 self.assertIs(self.cls(BASE, 'myfifo\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002291
2292 def test_is_socket_false(self):
2293 P = self.cls(BASE)
2294 self.assertFalse((P / 'fileA').is_socket())
2295 self.assertFalse((P / 'dirA').is_socket())
2296 self.assertFalse((P / 'non-existing').is_socket())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002297 self.assertFalse((P / 'fileA' / 'bah').is_socket())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002298 self.assertIs((P / 'fileA\udfff').is_socket(), False)
2299 self.assertIs((P / 'fileA\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002300
2301 @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required")
2302 def test_is_socket_true(self):
2303 P = self.cls(BASE, 'mysock')
Antoine Pitrou330ce592013-11-22 18:05:06 +01002304 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002305 self.addCleanup(sock.close)
Antoine Pitrou330ce592013-11-22 18:05:06 +01002306 try:
2307 sock.bind(str(P))
2308 except OSError as e:
Xavier de Gayee88ed052016-12-14 11:52:28 +01002309 if (isinstance(e, PermissionError) or
2310 "AF_UNIX path too long" in str(e)):
Antoine Pitrou330ce592013-11-22 18:05:06 +01002311 self.skipTest("cannot bind Unix socket: " + str(e))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002312 self.assertTrue(P.is_socket())
2313 self.assertFalse(P.is_fifo())
2314 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002315 self.assertIs(self.cls(BASE, 'mysock\udfff').is_socket(), False)
2316 self.assertIs(self.cls(BASE, 'mysock\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002317
2318 def test_is_block_device_false(self):
2319 P = self.cls(BASE)
2320 self.assertFalse((P / 'fileA').is_block_device())
2321 self.assertFalse((P / 'dirA').is_block_device())
2322 self.assertFalse((P / 'non-existing').is_block_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002323 self.assertFalse((P / 'fileA' / 'bah').is_block_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002324 self.assertIs((P / 'fileA\udfff').is_block_device(), False)
2325 self.assertIs((P / 'fileA\x00').is_block_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002326
2327 def test_is_char_device_false(self):
2328 P = self.cls(BASE)
2329 self.assertFalse((P / 'fileA').is_char_device())
2330 self.assertFalse((P / 'dirA').is_char_device())
2331 self.assertFalse((P / 'non-existing').is_char_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002332 self.assertFalse((P / 'fileA' / 'bah').is_char_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002333 self.assertIs((P / 'fileA\udfff').is_char_device(), False)
2334 self.assertIs((P / 'fileA\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002335
2336 def test_is_char_device_true(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002337 # Under Unix, /dev/null should generally be a char device.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002338 P = self.cls('/dev/null')
2339 if not P.exists():
2340 self.skipTest("/dev/null required")
2341 self.assertTrue(P.is_char_device())
2342 self.assertFalse(P.is_block_device())
2343 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002344 self.assertIs(self.cls('/dev/null\udfff').is_char_device(), False)
2345 self.assertIs(self.cls('/dev/null\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002346
2347 def test_pickling_common(self):
2348 p = self.cls(BASE, 'fileA')
2349 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
2350 dumped = pickle.dumps(p, proto)
2351 pp = pickle.loads(dumped)
2352 self.assertEqual(pp.stat(), p.stat())
2353
2354 def test_parts_interning(self):
2355 P = self.cls
2356 p = P('/usr/bin/foo')
2357 q = P('/usr/local/bin')
2358 # 'usr'
2359 self.assertIs(p.parts[1], q.parts[1])
2360 # 'bin'
2361 self.assertIs(p.parts[2], q.parts[3])
2362
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002363 def _check_complex_symlinks(self, link0_target):
Anthony Shaw83da9262019-01-07 07:31:29 +11002364 # Test solving a non-looping chain of symlinks (issue #19887).
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002365 P = self.cls(BASE)
2366 self.dirlink(os.path.join('link0', 'link0'), join('link1'))
2367 self.dirlink(os.path.join('link1', 'link1'), join('link2'))
2368 self.dirlink(os.path.join('link2', 'link2'), join('link3'))
2369 self.dirlink(link0_target, join('link0'))
2370
Anthony Shaw83da9262019-01-07 07:31:29 +11002371 # Resolve absolute paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002372 p = (P / 'link0').resolve()
2373 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002374 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002375 p = (P / 'link1').resolve()
2376 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002377 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002378 p = (P / 'link2').resolve()
2379 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002380 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002381 p = (P / 'link3').resolve()
2382 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002383 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002384
Anthony Shaw83da9262019-01-07 07:31:29 +11002385 # Resolve relative paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002386 old_path = os.getcwd()
2387 os.chdir(BASE)
2388 try:
2389 p = self.cls('link0').resolve()
2390 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002391 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002392 p = self.cls('link1').resolve()
2393 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002394 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002395 p = self.cls('link2').resolve()
2396 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002397 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002398 p = self.cls('link3').resolve()
2399 self.assertEqual(p, P)
Steve Dower97d79062019-09-10 14:52:48 +01002400 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002401 finally:
2402 os.chdir(old_path)
2403
Hai Shibb0424b2020-08-04 00:47:42 +08002404 @os_helper.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002405 def test_complex_symlinks_absolute(self):
2406 self._check_complex_symlinks(BASE)
2407
Hai Shibb0424b2020-08-04 00:47:42 +08002408 @os_helper.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002409 def test_complex_symlinks_relative(self):
2410 self._check_complex_symlinks('.')
2411
Hai Shibb0424b2020-08-04 00:47:42 +08002412 @os_helper.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002413 def test_complex_symlinks_relative_dot_dot(self):
2414 self._check_complex_symlinks(os.path.join('dirA', '..'))
2415
Antoine Pitrou31119e42013-11-22 17:38:12 +01002416
2417class PathTest(_BasePathTest, unittest.TestCase):
2418 cls = pathlib.Path
2419
Batuhan Taşkaya526606b2019-12-08 23:31:15 +03002420 def test_class_getitem(self):
2421 self.assertIs(self.cls[str], self.cls)
2422
Antoine Pitrou31119e42013-11-22 17:38:12 +01002423 def test_concrete_class(self):
2424 p = self.cls('a')
2425 self.assertIs(type(p),
2426 pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath)
2427
2428 def test_unsupported_flavour(self):
2429 if os.name == 'nt':
2430 self.assertRaises(NotImplementedError, pathlib.PosixPath)
2431 else:
2432 self.assertRaises(NotImplementedError, pathlib.WindowsPath)
2433
Berker Peksag4a208e42016-01-30 17:50:48 +02002434 def test_glob_empty_pattern(self):
2435 p = self.cls()
2436 with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
2437 list(p.glob(''))
2438
Antoine Pitrou31119e42013-11-22 17:38:12 +01002439
2440@only_posix
2441class PosixPathTest(_BasePathTest, unittest.TestCase):
2442 cls = pathlib.PosixPath
2443
Steve Dower98eb3602016-11-09 12:58:17 -08002444 def _check_symlink_loop(self, *args, strict=True):
Antoine Pitrou31119e42013-11-22 17:38:12 +01002445 path = self.cls(*args)
2446 with self.assertRaises(RuntimeError):
Steve Dower98eb3602016-11-09 12:58:17 -08002447 print(path.resolve(strict))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002448
2449 def test_open_mode(self):
2450 old_mask = os.umask(0)
2451 self.addCleanup(os.umask, old_mask)
2452 p = self.cls(BASE)
2453 with (p / 'new_file').open('wb'):
2454 pass
2455 st = os.stat(join('new_file'))
2456 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2457 os.umask(0o022)
2458 with (p / 'other_new_file').open('wb'):
2459 pass
2460 st = os.stat(join('other_new_file'))
2461 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2462
Dong-hee Na94ad6c62018-06-12 23:30:45 +09002463 def test_resolve_root(self):
2464 current_directory = os.getcwd()
2465 try:
2466 os.chdir('/')
2467 p = self.cls('spam')
2468 self.assertEqual(str(p.resolve()), '/spam')
2469 finally:
2470 os.chdir(current_directory)
2471
Antoine Pitrou31119e42013-11-22 17:38:12 +01002472 def test_touch_mode(self):
2473 old_mask = os.umask(0)
2474 self.addCleanup(os.umask, old_mask)
2475 p = self.cls(BASE)
2476 (p / 'new_file').touch()
2477 st = os.stat(join('new_file'))
2478 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2479 os.umask(0o022)
2480 (p / 'other_new_file').touch()
2481 st = os.stat(join('other_new_file'))
2482 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2483 (p / 'masked_new_file').touch(mode=0o750)
2484 st = os.stat(join('masked_new_file'))
2485 self.assertEqual(stat.S_IMODE(st.st_mode), 0o750)
2486
Hai Shibb0424b2020-08-04 00:47:42 +08002487 @os_helper.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01002488 def test_resolve_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002489 # Loops with relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002490 os.symlink('linkX/inside', join('linkX'))
2491 self._check_symlink_loop(BASE, 'linkX')
2492 os.symlink('linkY', join('linkY'))
2493 self._check_symlink_loop(BASE, 'linkY')
2494 os.symlink('linkZ/../linkZ', join('linkZ'))
2495 self._check_symlink_loop(BASE, 'linkZ')
Steve Dower98eb3602016-11-09 12:58:17 -08002496 # Non-strict
2497 self._check_symlink_loop(BASE, 'linkZ', 'foo', strict=False)
Anthony Shaw83da9262019-01-07 07:31:29 +11002498 # Loops with absolute symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002499 os.symlink(join('linkU/inside'), join('linkU'))
2500 self._check_symlink_loop(BASE, 'linkU')
2501 os.symlink(join('linkV'), join('linkV'))
2502 self._check_symlink_loop(BASE, 'linkV')
2503 os.symlink(join('linkW/../linkW'), join('linkW'))
2504 self._check_symlink_loop(BASE, 'linkW')
Steve Dower98eb3602016-11-09 12:58:17 -08002505 # Non-strict
2506 self._check_symlink_loop(BASE, 'linkW', 'foo', strict=False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002507
2508 def test_glob(self):
2509 P = self.cls
2510 p = P(BASE)
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002511 given = set(p.glob("FILEa"))
Hai Shibb0424b2020-08-04 00:47:42 +08002512 expect = set() if not os_helper.fs_is_case_insensitive(BASE) else given
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002513 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002514 self.assertEqual(set(p.glob("FILEa*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002515
2516 def test_rglob(self):
2517 P = self.cls
2518 p = P(BASE, "dirC")
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002519 given = set(p.rglob("FILEd"))
Hai Shibb0424b2020-08-04 00:47:42 +08002520 expect = set() if not os_helper.fs_is_case_insensitive(BASE) else given
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002521 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002522 self.assertEqual(set(p.rglob("FILEd*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002523
Xavier de Gayefb24eea2016-12-13 09:11:38 +01002524 @unittest.skipUnless(hasattr(pwd, 'getpwall'),
2525 'pwd module does not expose getpwall()')
pxinwrb2304092020-12-16 05:24:00 +08002526 @unittest.skipIf(sys.platform == "vxworks",
2527 "no home directory on VxWorks")
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002528 def test_expanduser(self):
2529 P = self.cls
Hai Shibb0424b2020-08-04 00:47:42 +08002530 import_helper.import_module('pwd')
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002531 import pwd
2532 pwdent = pwd.getpwuid(os.getuid())
2533 username = pwdent.pw_name
Serhiy Storchakaa3fd0b22016-05-03 21:17:03 +03002534 userhome = pwdent.pw_dir.rstrip('/') or '/'
Anthony Shaw83da9262019-01-07 07:31:29 +11002535 # Find arbitrary different user (if exists).
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002536 for pwdent in pwd.getpwall():
2537 othername = pwdent.pw_name
2538 otherhome = pwdent.pw_dir.rstrip('/')
Victor Stinnere9694392015-01-10 09:00:20 +01002539 if othername != username and otherhome:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002540 break
Anders Kaseorg5c0d4622018-05-14 10:00:37 -04002541 else:
2542 othername = username
2543 otherhome = userhome
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002544
2545 p1 = P('~/Documents')
2546 p2 = P('~' + username + '/Documents')
2547 p3 = P('~' + othername + '/Documents')
2548 p4 = P('../~' + username + '/Documents')
2549 p5 = P('/~' + username + '/Documents')
2550 p6 = P('')
2551 p7 = P('~fakeuser/Documents')
2552
Hai Shibb0424b2020-08-04 00:47:42 +08002553 with os_helper.EnvironmentVarGuard() as env:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002554 env.pop('HOME', None)
2555
2556 self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
2557 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2558 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2559 self.assertEqual(p4.expanduser(), p4)
2560 self.assertEqual(p5.expanduser(), p5)
2561 self.assertEqual(p6.expanduser(), p6)
2562 self.assertRaises(RuntimeError, p7.expanduser)
2563
2564 env['HOME'] = '/tmp'
2565 self.assertEqual(p1.expanduser(), P('/tmp/Documents'))
2566 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2567 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2568 self.assertEqual(p4.expanduser(), p4)
2569 self.assertEqual(p5.expanduser(), p5)
2570 self.assertEqual(p6.expanduser(), p6)
2571 self.assertRaises(RuntimeError, p7.expanduser)
2572
Przemysław Spodymek216b7452018-08-27 23:33:45 +02002573 @unittest.skipIf(sys.platform != "darwin",
2574 "Bad file descriptor in /dev/fd affects only macOS")
2575 def test_handling_bad_descriptor(self):
2576 try:
2577 file_descriptors = list(pathlib.Path('/dev/fd').rglob("*"))[3:]
2578 if not file_descriptors:
2579 self.skipTest("no file descriptors - issue was not reproduced")
2580 # Checking all file descriptors because there is no guarantee
2581 # which one will fail.
2582 for f in file_descriptors:
2583 f.exists()
2584 f.is_dir()
2585 f.is_file()
2586 f.is_symlink()
2587 f.is_block_device()
2588 f.is_char_device()
2589 f.is_fifo()
2590 f.is_socket()
2591 except OSError as e:
2592 if e.errno == errno.EBADF:
2593 self.fail("Bad file descriptor not handled.")
2594 raise
2595
Antoine Pitrou31119e42013-11-22 17:38:12 +01002596
2597@only_nt
2598class WindowsPathTest(_BasePathTest, unittest.TestCase):
2599 cls = pathlib.WindowsPath
2600
2601 def test_glob(self):
2602 P = self.cls
2603 p = P(BASE)
2604 self.assertEqual(set(p.glob("FILEa")), { P(BASE, "fileA") })
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +03002605 self.assertEqual(set(p.glob("F*a")), { P(BASE, "fileA") })
2606 self.assertEqual(set(map(str, p.glob("FILEa"))), {f"{p}\\FILEa"})
2607 self.assertEqual(set(map(str, p.glob("F*a"))), {f"{p}\\fileA"})
Antoine Pitrou31119e42013-11-22 17:38:12 +01002608
2609 def test_rglob(self):
2610 P = self.cls
2611 p = P(BASE, "dirC")
2612 self.assertEqual(set(p.rglob("FILEd")), { P(BASE, "dirC/dirD/fileD") })
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +03002613 self.assertEqual(set(map(str, p.rglob("FILEd"))), {f"{p}\\dirD\\FILEd"})
Antoine Pitrou31119e42013-11-22 17:38:12 +01002614
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002615 def test_expanduser(self):
2616 P = self.cls
Hai Shibb0424b2020-08-04 00:47:42 +08002617 with os_helper.EnvironmentVarGuard() as env:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002618 env.pop('HOME', None)
2619 env.pop('USERPROFILE', None)
2620 env.pop('HOMEPATH', None)
2621 env.pop('HOMEDRIVE', None)
2622 env['USERNAME'] = 'alice'
2623
2624 # test that the path returns unchanged
2625 p1 = P('~/My Documents')
2626 p2 = P('~alice/My Documents')
2627 p3 = P('~bob/My Documents')
2628 p4 = P('/~/My Documents')
2629 p5 = P('d:~/My Documents')
2630 p6 = P('')
2631 self.assertRaises(RuntimeError, p1.expanduser)
2632 self.assertRaises(RuntimeError, p2.expanduser)
2633 self.assertRaises(RuntimeError, p3.expanduser)
2634 self.assertEqual(p4.expanduser(), p4)
2635 self.assertEqual(p5.expanduser(), p5)
2636 self.assertEqual(p6.expanduser(), p6)
2637
2638 def check():
2639 env.pop('USERNAME', None)
2640 self.assertEqual(p1.expanduser(),
2641 P('C:/Users/alice/My Documents'))
Barney Gale3f3d82b2021-04-07 23:50:13 +01002642 self.assertRaises(RuntimeError, p2.expanduser)
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002643 env['USERNAME'] = 'alice'
2644 self.assertEqual(p2.expanduser(),
2645 P('C:/Users/alice/My Documents'))
2646 self.assertEqual(p3.expanduser(),
2647 P('C:/Users/bob/My Documents'))
2648 self.assertEqual(p4.expanduser(), p4)
2649 self.assertEqual(p5.expanduser(), p5)
2650 self.assertEqual(p6.expanduser(), p6)
2651
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002652 env['HOMEPATH'] = 'C:\\Users\\alice'
2653 check()
2654
2655 env['HOMEDRIVE'] = 'C:\\'
2656 env['HOMEPATH'] = 'Users\\alice'
2657 check()
2658
2659 env.pop('HOMEDRIVE', None)
2660 env.pop('HOMEPATH', None)
2661 env['USERPROFILE'] = 'C:\\Users\\alice'
2662 check()
2663
Christoph Reiterc45a2aa2020-01-28 10:41:50 +01002664 # bpo-38883: ignore `HOME` when set on windows
2665 env['HOME'] = 'C:\\Users\\eve'
2666 check()
2667
Antoine Pitrou31119e42013-11-22 17:38:12 +01002668
aiudirog4c69be22019-08-08 01:41:10 -04002669class CompatiblePathTest(unittest.TestCase):
2670 """
2671 Test that a type can be made compatible with PurePath
2672 derivatives by implementing division operator overloads.
2673 """
2674
2675 class CompatPath:
2676 """
2677 Minimum viable class to test PurePath compatibility.
2678 Simply uses the division operator to join a given
2679 string and the string value of another object with
2680 a forward slash.
2681 """
2682 def __init__(self, string):
2683 self.string = string
2684
2685 def __truediv__(self, other):
2686 return type(self)(f"{self.string}/{other}")
2687
2688 def __rtruediv__(self, other):
2689 return type(self)(f"{other}/{self.string}")
2690
2691 def test_truediv(self):
2692 result = pathlib.PurePath("test") / self.CompatPath("right")
2693 self.assertIsInstance(result, self.CompatPath)
2694 self.assertEqual(result.string, "test/right")
2695
2696 with self.assertRaises(TypeError):
2697 # Verify improper operations still raise a TypeError
2698 pathlib.PurePath("test") / 10
2699
2700 def test_rtruediv(self):
2701 result = self.CompatPath("left") / pathlib.PurePath("test")
2702 self.assertIsInstance(result, self.CompatPath)
2703 self.assertEqual(result.string, "left/test")
2704
2705 with self.assertRaises(TypeError):
2706 # Verify improper operations still raise a TypeError
2707 10 / pathlib.PurePath("test")
2708
2709
Antoine Pitrou31119e42013-11-22 17:38:12 +01002710if __name__ == "__main__":
2711 unittest.main()