blob: 95d0b09882f6c96ef8373d0069ccf8afe84cb943 [file] [log] [blame]
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001import collections.abc
Antoine Pitrou31119e42013-11-22 17:38:12 +01002import io
3import os
Przemysław Spodymek216b7452018-08-27 23:33:45 +02004import sys
Antoine Pitrou31119e42013-11-22 17:38:12 +01005import errno
6import pathlib
7import pickle
Antoine Pitrou31119e42013-11-22 17:38:12 +01008import socket
9import stat
Antoine Pitrou31119e42013-11-22 17:38:12 +010010import tempfile
11import unittest
Armin Rigo22a594a2017-04-13 20:08:15 +020012from unittest import mock
Antoine Pitrou31119e42013-11-22 17:38:12 +010013
14from test import support
Serhiy Storchakab21d1552018-03-02 11:53:51 +020015from test.support import TESTFN, FakePath
Antoine Pitrou31119e42013-11-22 17:38:12 +010016
17try:
18 import grp, pwd
19except ImportError:
20 grp = pwd = None
21
22
23class _BaseFlavourTest(object):
24
25 def _check_parse_parts(self, arg, expected):
26 f = self.flavour.parse_parts
27 sep = self.flavour.sep
28 altsep = self.flavour.altsep
29 actual = f([x.replace('/', sep) for x in arg])
30 self.assertEqual(actual, expected)
31 if altsep:
32 actual = f([x.replace('/', altsep) for x in arg])
33 self.assertEqual(actual, expected)
34
35 def test_parse_parts_common(self):
36 check = self._check_parse_parts
37 sep = self.flavour.sep
Anthony Shaw83da9262019-01-07 07:31:29 +110038 # Unanchored parts.
Antoine Pitrou31119e42013-11-22 17:38:12 +010039 check([], ('', '', []))
40 check(['a'], ('', '', ['a']))
41 check(['a/'], ('', '', ['a']))
42 check(['a', 'b'], ('', '', ['a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110043 # Expansion.
Antoine Pitrou31119e42013-11-22 17:38:12 +010044 check(['a/b'], ('', '', ['a', 'b']))
45 check(['a/b/'], ('', '', ['a', 'b']))
46 check(['a', 'b/c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +110047 # Collapsing and stripping excess slashes.
Antoine Pitrou31119e42013-11-22 17:38:12 +010048 check(['a', 'b//c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
49 check(['a', 'b/c/', 'd'], ('', '', ['a', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +110050 # Eliminating standalone dots.
Antoine Pitrou31119e42013-11-22 17:38:12 +010051 check(['.'], ('', '', []))
52 check(['.', '.', 'b'], ('', '', ['b']))
53 check(['a', '.', 'b'], ('', '', ['a', 'b']))
54 check(['a', '.', '.'], ('', '', ['a']))
Anthony Shaw83da9262019-01-07 07:31:29 +110055 # The first part is anchored.
Antoine Pitrou31119e42013-11-22 17:38:12 +010056 check(['/a/b'], ('', sep, [sep, 'a', 'b']))
57 check(['/a', 'b'], ('', sep, [sep, 'a', 'b']))
58 check(['/a/', 'b'], ('', sep, [sep, 'a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110059 # Ignoring parts before an anchored part.
Antoine Pitrou31119e42013-11-22 17:38:12 +010060 check(['a', '/b', 'c'], ('', sep, [sep, 'b', 'c']))
61 check(['a', '/b', '/c'], ('', sep, [sep, 'c']))
62
63
64class PosixFlavourTest(_BaseFlavourTest, unittest.TestCase):
65 flavour = pathlib._posix_flavour
66
67 def test_parse_parts(self):
68 check = self._check_parse_parts
69 # Collapsing of excess leading slashes, except for the double-slash
70 # special case.
71 check(['//a', 'b'], ('', '//', ['//', 'a', 'b']))
72 check(['///a', 'b'], ('', '/', ['/', 'a', 'b']))
73 check(['////a', 'b'], ('', '/', ['/', 'a', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +110074 # Paths which look like NT paths aren't treated specially.
Antoine Pitrou31119e42013-11-22 17:38:12 +010075 check(['c:a'], ('', '', ['c:a']))
76 check(['c:\\a'], ('', '', ['c:\\a']))
77 check(['\\a'], ('', '', ['\\a']))
78
79 def test_splitroot(self):
80 f = self.flavour.splitroot
81 self.assertEqual(f(''), ('', '', ''))
82 self.assertEqual(f('a'), ('', '', 'a'))
83 self.assertEqual(f('a/b'), ('', '', 'a/b'))
84 self.assertEqual(f('a/b/'), ('', '', 'a/b/'))
85 self.assertEqual(f('/a'), ('', '/', 'a'))
86 self.assertEqual(f('/a/b'), ('', '/', 'a/b'))
87 self.assertEqual(f('/a/b/'), ('', '/', 'a/b/'))
88 # The root is collapsed when there are redundant slashes
89 # except when there are exactly two leading slashes, which
90 # is a special case in POSIX.
91 self.assertEqual(f('//a'), ('', '//', 'a'))
92 self.assertEqual(f('///a'), ('', '/', 'a'))
93 self.assertEqual(f('///a/b'), ('', '/', 'a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +110094 # Paths which look like NT paths aren't treated specially.
Antoine Pitrou31119e42013-11-22 17:38:12 +010095 self.assertEqual(f('c:/a/b'), ('', '', 'c:/a/b'))
96 self.assertEqual(f('\\/a/b'), ('', '', '\\/a/b'))
97 self.assertEqual(f('\\a\\b'), ('', '', '\\a\\b'))
98
99
100class NTFlavourTest(_BaseFlavourTest, unittest.TestCase):
101 flavour = pathlib._windows_flavour
102
103 def test_parse_parts(self):
104 check = self._check_parse_parts
Anthony Shaw83da9262019-01-07 07:31:29 +1100105 # First part is anchored.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100106 check(['c:'], ('c:', '', ['c:']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100107 check(['c:/'], ('c:', '\\', ['c:\\']))
108 check(['/'], ('', '\\', ['\\']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100109 check(['c:a'], ('c:', '', ['c:', 'a']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100110 check(['c:/a'], ('c:', '\\', ['c:\\', 'a']))
111 check(['/a'], ('', '\\', ['\\', 'a']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100112 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100113 check(['//a/b'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
114 check(['//a/b/'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
115 check(['//a/b/c'], ('\\\\a\\b', '\\', ['\\\\a\\b\\', 'c']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100116 # Second part is anchored, so that the first part is ignored.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100117 check(['a', 'Z:b', 'c'], ('Z:', '', ['Z:', 'b', 'c']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100118 check(['a', 'Z:/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100119 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100120 check(['a', '//b/c', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100121 # Collapsing and stripping excess slashes.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100122 check(['a', 'Z://b//c/', 'd/'], ('Z:', '\\', ['Z:\\', 'b', 'c', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100123 # UNC paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100124 check(['a', '//b/c//', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100125 # Extended paths.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100126 check(['//?/c:/'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\']))
127 check(['//?/c:/a'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'a']))
128 check(['//?/c:/a', '/b'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'b']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100129 # Extended UNC paths (format is "\\?\UNC\server\share").
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100130 check(['//?/UNC/b/c'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\']))
131 check(['//?/UNC/b/c/d'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\', 'd']))
Anthony Shaw83da9262019-01-07 07:31:29 +1100132 # Second part has a root but not drive.
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100133 check(['a', '/b', 'c'], ('', '\\', ['\\', 'b', 'c']))
134 check(['Z:/a', '/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
135 check(['//?/Z:/a', '/b', 'c'], ('\\\\?\\Z:', '\\', ['\\\\?\\Z:\\', 'b', 'c']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100136
137 def test_splitroot(self):
138 f = self.flavour.splitroot
139 self.assertEqual(f(''), ('', '', ''))
140 self.assertEqual(f('a'), ('', '', 'a'))
141 self.assertEqual(f('a\\b'), ('', '', 'a\\b'))
142 self.assertEqual(f('\\a'), ('', '\\', 'a'))
143 self.assertEqual(f('\\a\\b'), ('', '\\', 'a\\b'))
144 self.assertEqual(f('c:a\\b'), ('c:', '', 'a\\b'))
145 self.assertEqual(f('c:\\a\\b'), ('c:', '\\', 'a\\b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100146 # Redundant slashes in the root are collapsed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100147 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
148 self.assertEqual(f('\\\\\\a/b'), ('', '\\', 'a/b'))
149 self.assertEqual(f('c:\\\\a'), ('c:', '\\', 'a'))
150 self.assertEqual(f('c:\\\\\\a/b'), ('c:', '\\', 'a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100151 # Valid UNC paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100152 self.assertEqual(f('\\\\a\\b'), ('\\\\a\\b', '\\', ''))
153 self.assertEqual(f('\\\\a\\b\\'), ('\\\\a\\b', '\\', ''))
154 self.assertEqual(f('\\\\a\\b\\c\\d'), ('\\\\a\\b', '\\', 'c\\d'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100155 # These are non-UNC paths (according to ntpath.py and test_ntpath).
Antoine Pitrou31119e42013-11-22 17:38:12 +0100156 # However, command.com says such paths are invalid, so it's
Anthony Shaw83da9262019-01-07 07:31:29 +1100157 # difficult to know what the right semantics are.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100158 self.assertEqual(f('\\\\\\a\\b'), ('', '\\', 'a\\b'))
159 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
160
161
162#
Anthony Shaw83da9262019-01-07 07:31:29 +1100163# Tests for the pure classes.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100164#
165
166class _BasePurePathTest(object):
167
Anthony Shaw83da9262019-01-07 07:31:29 +1100168 # Keys are canonical paths, values are list of tuples of arguments
169 # supposed to produce equal paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100170 equivalences = {
171 'a/b': [
172 ('a', 'b'), ('a/', 'b'), ('a', 'b/'), ('a/', 'b/'),
173 ('a/b/',), ('a//b',), ('a//b//',),
Anthony Shaw83da9262019-01-07 07:31:29 +1100174 # Empty components get removed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100175 ('', 'a', 'b'), ('a', '', 'b'), ('a', 'b', ''),
176 ],
177 '/b/c/d': [
178 ('a', '/b/c', 'd'), ('a', '///b//c', 'd/'),
179 ('/a', '/b/c', 'd'),
Anthony Shaw83da9262019-01-07 07:31:29 +1100180 # Empty components get removed.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100181 ('/', 'b', '', 'c/d'), ('/', '', 'b/c/d'), ('', '/b/c/d'),
182 ],
183 }
184
185 def setUp(self):
186 p = self.cls('a')
187 self.flavour = p._flavour
188 self.sep = self.flavour.sep
189 self.altsep = self.flavour.altsep
190
191 def test_constructor_common(self):
192 P = self.cls
193 p = P('a')
194 self.assertIsInstance(p, P)
195 P('a', 'b', 'c')
196 P('/a', 'b', 'c')
197 P('a/b/c')
198 P('/a/b/c')
Serhiy Storchakab21d1552018-03-02 11:53:51 +0200199 P(FakePath("a/b/c"))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100200 self.assertEqual(P(P('a')), P('a'))
201 self.assertEqual(P(P('a'), 'b'), P('a/b'))
202 self.assertEqual(P(P('a'), P('b')), P('a/b'))
Serhiy Storchakab21d1552018-03-02 11:53:51 +0200203 self.assertEqual(P(P('a'), P('b'), P('c')), P(FakePath("a/b/c")))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100204
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200205 def _check_str_subclass(self, *args):
206 # Issue #21127: it should be possible to construct a PurePath object
Serhiy Storchaka6a7b3a72016-04-17 08:32:47 +0300207 # from a str subclass instance, and it then gets converted to
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200208 # a pure str object.
209 class StrSubclass(str):
210 pass
211 P = self.cls
212 p = P(*(StrSubclass(x) for x in args))
213 self.assertEqual(p, P(*args))
214 for part in p.parts:
215 self.assertIs(type(part), str)
216
217 def test_str_subclass_common(self):
218 self._check_str_subclass('')
219 self._check_str_subclass('.')
220 self._check_str_subclass('a')
221 self._check_str_subclass('a/b.txt')
222 self._check_str_subclass('/a/b.txt')
223
Antoine Pitrou31119e42013-11-22 17:38:12 +0100224 def test_join_common(self):
225 P = self.cls
226 p = P('a/b')
227 pp = p.joinpath('c')
228 self.assertEqual(pp, P('a/b/c'))
229 self.assertIs(type(pp), type(p))
230 pp = p.joinpath('c', 'd')
231 self.assertEqual(pp, P('a/b/c/d'))
232 pp = p.joinpath(P('c'))
233 self.assertEqual(pp, P('a/b/c'))
234 pp = p.joinpath('/c')
235 self.assertEqual(pp, P('/c'))
236
237 def test_div_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100238 # Basically the same as joinpath().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100239 P = self.cls
240 p = P('a/b')
241 pp = p / 'c'
242 self.assertEqual(pp, P('a/b/c'))
243 self.assertIs(type(pp), type(p))
244 pp = p / 'c/d'
245 self.assertEqual(pp, P('a/b/c/d'))
246 pp = p / 'c' / 'd'
247 self.assertEqual(pp, P('a/b/c/d'))
248 pp = 'c' / p / 'd'
249 self.assertEqual(pp, P('c/a/b/d'))
250 pp = p / P('c')
251 self.assertEqual(pp, P('a/b/c'))
252 pp = p/ '/c'
253 self.assertEqual(pp, P('/c'))
254
255 def _check_str(self, expected, args):
256 p = self.cls(*args)
257 self.assertEqual(str(p), expected.replace('/', self.sep))
258
259 def test_str_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100260 # Canonicalized paths roundtrip.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100261 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
262 self._check_str(pathstr, (pathstr,))
Anthony Shaw83da9262019-01-07 07:31:29 +1100263 # Special case for the empty path.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100264 self._check_str('.', ('',))
Anthony Shaw83da9262019-01-07 07:31:29 +1100265 # Other tests for str() are in test_equivalences().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100266
267 def test_as_posix_common(self):
268 P = self.cls
269 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
270 self.assertEqual(P(pathstr).as_posix(), pathstr)
Anthony Shaw83da9262019-01-07 07:31:29 +1100271 # Other tests for as_posix() are in test_equivalences().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100272
273 def test_as_bytes_common(self):
274 sep = os.fsencode(self.sep)
275 P = self.cls
276 self.assertEqual(bytes(P('a/b')), b'a' + sep + b'b')
277
278 def test_as_uri_common(self):
279 P = self.cls
280 with self.assertRaises(ValueError):
281 P('a').as_uri()
282 with self.assertRaises(ValueError):
283 P().as_uri()
284
285 def test_repr_common(self):
286 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
287 p = self.cls(pathstr)
288 clsname = p.__class__.__name__
289 r = repr(p)
Anthony Shaw83da9262019-01-07 07:31:29 +1100290 # The repr() is in the form ClassName("forward-slashes path").
Antoine Pitrou31119e42013-11-22 17:38:12 +0100291 self.assertTrue(r.startswith(clsname + '('), r)
292 self.assertTrue(r.endswith(')'), r)
293 inner = r[len(clsname) + 1 : -1]
294 self.assertEqual(eval(inner), p.as_posix())
Anthony Shaw83da9262019-01-07 07:31:29 +1100295 # The repr() roundtrips.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100296 q = eval(r, pathlib.__dict__)
297 self.assertIs(q.__class__, p.__class__)
298 self.assertEqual(q, p)
299 self.assertEqual(repr(q), r)
300
301 def test_eq_common(self):
302 P = self.cls
303 self.assertEqual(P('a/b'), P('a/b'))
304 self.assertEqual(P('a/b'), P('a', 'b'))
305 self.assertNotEqual(P('a/b'), P('a'))
306 self.assertNotEqual(P('a/b'), P('/a/b'))
307 self.assertNotEqual(P('a/b'), P())
308 self.assertNotEqual(P('/a/b'), P('/'))
309 self.assertNotEqual(P(), P('/'))
310 self.assertNotEqual(P(), "")
311 self.assertNotEqual(P(), {})
312 self.assertNotEqual(P(), int)
313
314 def test_match_common(self):
315 P = self.cls
316 self.assertRaises(ValueError, P('a').match, '')
317 self.assertRaises(ValueError, P('a').match, '.')
Anthony Shaw83da9262019-01-07 07:31:29 +1100318 # Simple relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100319 self.assertTrue(P('b.py').match('b.py'))
320 self.assertTrue(P('a/b.py').match('b.py'))
321 self.assertTrue(P('/a/b.py').match('b.py'))
322 self.assertFalse(P('a.py').match('b.py'))
323 self.assertFalse(P('b/py').match('b.py'))
324 self.assertFalse(P('/a.py').match('b.py'))
325 self.assertFalse(P('b.py/c').match('b.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100326 # Wilcard relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100327 self.assertTrue(P('b.py').match('*.py'))
328 self.assertTrue(P('a/b.py').match('*.py'))
329 self.assertTrue(P('/a/b.py').match('*.py'))
330 self.assertFalse(P('b.pyc').match('*.py'))
331 self.assertFalse(P('b./py').match('*.py'))
332 self.assertFalse(P('b.py/c').match('*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100333 # Multi-part relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100334 self.assertTrue(P('ab/c.py').match('a*/*.py'))
335 self.assertTrue(P('/d/ab/c.py').match('a*/*.py'))
336 self.assertFalse(P('a.py').match('a*/*.py'))
337 self.assertFalse(P('/dab/c.py').match('a*/*.py'))
338 self.assertFalse(P('ab/c.py/d').match('a*/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100339 # Absolute pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100340 self.assertTrue(P('/b.py').match('/*.py'))
341 self.assertFalse(P('b.py').match('/*.py'))
342 self.assertFalse(P('a/b.py').match('/*.py'))
343 self.assertFalse(P('/a/b.py').match('/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100344 # Multi-part absolute pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100345 self.assertTrue(P('/a/b.py').match('/a/*.py'))
346 self.assertFalse(P('/ab.py').match('/a/*.py'))
347 self.assertFalse(P('/a/b/c.py').match('/a/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100348 # Multi-part glob-style pattern.
349 self.assertFalse(P('/a/b/c.py').match('/**/*.py'))
350 self.assertTrue(P('/a/b/c.py').match('/a/**/*.py'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100351
352 def test_ordering_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100353 # Ordering is tuple-alike.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100354 def assertLess(a, b):
355 self.assertLess(a, b)
356 self.assertGreater(b, a)
357 P = self.cls
358 a = P('a')
359 b = P('a/b')
360 c = P('abc')
361 d = P('b')
362 assertLess(a, b)
363 assertLess(a, c)
364 assertLess(a, d)
365 assertLess(b, c)
366 assertLess(c, d)
367 P = self.cls
368 a = P('/a')
369 b = P('/a/b')
370 c = P('/abc')
371 d = P('/b')
372 assertLess(a, b)
373 assertLess(a, c)
374 assertLess(a, d)
375 assertLess(b, c)
376 assertLess(c, d)
377 with self.assertRaises(TypeError):
378 P() < {}
379
380 def test_parts_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100381 # `parts` returns a tuple.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100382 sep = self.sep
383 P = self.cls
384 p = P('a/b')
385 parts = p.parts
386 self.assertEqual(parts, ('a', 'b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100387 # The object gets reused.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100388 self.assertIs(parts, p.parts)
Anthony Shaw83da9262019-01-07 07:31:29 +1100389 # When the path is absolute, the anchor is a separate part.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100390 p = P('/a/b')
391 parts = p.parts
392 self.assertEqual(parts, (sep, 'a', 'b'))
393
Brett Cannon568be632016-06-10 12:20:49 -0700394 def test_fspath_common(self):
395 P = self.cls
396 p = P('a/b')
397 self._check_str(p.__fspath__(), ('a/b',))
398 self._check_str(os.fspath(p), ('a/b',))
399
Antoine Pitrou31119e42013-11-22 17:38:12 +0100400 def test_equivalences(self):
401 for k, tuples in self.equivalences.items():
402 canon = k.replace('/', self.sep)
403 posix = k.replace(self.sep, '/')
404 if canon != posix:
405 tuples = tuples + [
406 tuple(part.replace('/', self.sep) for part in t)
407 for t in tuples
408 ]
409 tuples.append((posix, ))
410 pcanon = self.cls(canon)
411 for t in tuples:
412 p = self.cls(*t)
413 self.assertEqual(p, pcanon, "failed with args {}".format(t))
414 self.assertEqual(hash(p), hash(pcanon))
415 self.assertEqual(str(p), canon)
416 self.assertEqual(p.as_posix(), posix)
417
418 def test_parent_common(self):
419 # Relative
420 P = self.cls
421 p = P('a/b/c')
422 self.assertEqual(p.parent, P('a/b'))
423 self.assertEqual(p.parent.parent, P('a'))
424 self.assertEqual(p.parent.parent.parent, P())
425 self.assertEqual(p.parent.parent.parent.parent, P())
426 # Anchored
427 p = P('/a/b/c')
428 self.assertEqual(p.parent, P('/a/b'))
429 self.assertEqual(p.parent.parent, P('/a'))
430 self.assertEqual(p.parent.parent.parent, P('/'))
431 self.assertEqual(p.parent.parent.parent.parent, P('/'))
432
433 def test_parents_common(self):
434 # Relative
435 P = self.cls
436 p = P('a/b/c')
437 par = p.parents
438 self.assertEqual(len(par), 3)
439 self.assertEqual(par[0], P('a/b'))
440 self.assertEqual(par[1], P('a'))
441 self.assertEqual(par[2], P('.'))
442 self.assertEqual(list(par), [P('a/b'), P('a'), P('.')])
443 with self.assertRaises(IndexError):
444 par[-1]
445 with self.assertRaises(IndexError):
446 par[3]
447 with self.assertRaises(TypeError):
448 par[0] = p
449 # Anchored
450 p = P('/a/b/c')
451 par = p.parents
452 self.assertEqual(len(par), 3)
453 self.assertEqual(par[0], P('/a/b'))
454 self.assertEqual(par[1], P('/a'))
455 self.assertEqual(par[2], P('/'))
456 self.assertEqual(list(par), [P('/a/b'), P('/a'), P('/')])
457 with self.assertRaises(IndexError):
458 par[3]
459
460 def test_drive_common(self):
461 P = self.cls
462 self.assertEqual(P('a/b').drive, '')
463 self.assertEqual(P('/a/b').drive, '')
464 self.assertEqual(P('').drive, '')
465
466 def test_root_common(self):
467 P = self.cls
468 sep = self.sep
469 self.assertEqual(P('').root, '')
470 self.assertEqual(P('a/b').root, '')
471 self.assertEqual(P('/').root, sep)
472 self.assertEqual(P('/a/b').root, sep)
473
474 def test_anchor_common(self):
475 P = self.cls
476 sep = self.sep
477 self.assertEqual(P('').anchor, '')
478 self.assertEqual(P('a/b').anchor, '')
479 self.assertEqual(P('/').anchor, sep)
480 self.assertEqual(P('/a/b').anchor, sep)
481
482 def test_name_common(self):
483 P = self.cls
484 self.assertEqual(P('').name, '')
485 self.assertEqual(P('.').name, '')
486 self.assertEqual(P('/').name, '')
487 self.assertEqual(P('a/b').name, 'b')
488 self.assertEqual(P('/a/b').name, 'b')
489 self.assertEqual(P('/a/b/.').name, 'b')
490 self.assertEqual(P('a/b.py').name, 'b.py')
491 self.assertEqual(P('/a/b.py').name, 'b.py')
492
493 def test_suffix_common(self):
494 P = self.cls
495 self.assertEqual(P('').suffix, '')
496 self.assertEqual(P('.').suffix, '')
497 self.assertEqual(P('..').suffix, '')
498 self.assertEqual(P('/').suffix, '')
499 self.assertEqual(P('a/b').suffix, '')
500 self.assertEqual(P('/a/b').suffix, '')
501 self.assertEqual(P('/a/b/.').suffix, '')
502 self.assertEqual(P('a/b.py').suffix, '.py')
503 self.assertEqual(P('/a/b.py').suffix, '.py')
504 self.assertEqual(P('a/.hgrc').suffix, '')
505 self.assertEqual(P('/a/.hgrc').suffix, '')
506 self.assertEqual(P('a/.hg.rc').suffix, '.rc')
507 self.assertEqual(P('/a/.hg.rc').suffix, '.rc')
508 self.assertEqual(P('a/b.tar.gz').suffix, '.gz')
509 self.assertEqual(P('/a/b.tar.gz').suffix, '.gz')
510 self.assertEqual(P('a/Some name. Ending with a dot.').suffix, '')
511 self.assertEqual(P('/a/Some name. Ending with a dot.').suffix, '')
512
513 def test_suffixes_common(self):
514 P = self.cls
515 self.assertEqual(P('').suffixes, [])
516 self.assertEqual(P('.').suffixes, [])
517 self.assertEqual(P('/').suffixes, [])
518 self.assertEqual(P('a/b').suffixes, [])
519 self.assertEqual(P('/a/b').suffixes, [])
520 self.assertEqual(P('/a/b/.').suffixes, [])
521 self.assertEqual(P('a/b.py').suffixes, ['.py'])
522 self.assertEqual(P('/a/b.py').suffixes, ['.py'])
523 self.assertEqual(P('a/.hgrc').suffixes, [])
524 self.assertEqual(P('/a/.hgrc').suffixes, [])
525 self.assertEqual(P('a/.hg.rc').suffixes, ['.rc'])
526 self.assertEqual(P('/a/.hg.rc').suffixes, ['.rc'])
527 self.assertEqual(P('a/b.tar.gz').suffixes, ['.tar', '.gz'])
528 self.assertEqual(P('/a/b.tar.gz').suffixes, ['.tar', '.gz'])
529 self.assertEqual(P('a/Some name. Ending with a dot.').suffixes, [])
530 self.assertEqual(P('/a/Some name. Ending with a dot.').suffixes, [])
531
532 def test_stem_common(self):
533 P = self.cls
534 self.assertEqual(P('').stem, '')
535 self.assertEqual(P('.').stem, '')
536 self.assertEqual(P('..').stem, '..')
537 self.assertEqual(P('/').stem, '')
538 self.assertEqual(P('a/b').stem, 'b')
539 self.assertEqual(P('a/b.py').stem, 'b')
540 self.assertEqual(P('a/.hgrc').stem, '.hgrc')
541 self.assertEqual(P('a/.hg.rc').stem, '.hg')
542 self.assertEqual(P('a/b.tar.gz').stem, 'b.tar')
543 self.assertEqual(P('a/Some name. Ending with a dot.').stem,
544 'Some name. Ending with a dot.')
545
546 def test_with_name_common(self):
547 P = self.cls
548 self.assertEqual(P('a/b').with_name('d.xml'), P('a/d.xml'))
549 self.assertEqual(P('/a/b').with_name('d.xml'), P('/a/d.xml'))
550 self.assertEqual(P('a/b.py').with_name('d.xml'), P('a/d.xml'))
551 self.assertEqual(P('/a/b.py').with_name('d.xml'), P('/a/d.xml'))
552 self.assertEqual(P('a/Dot ending.').with_name('d.xml'), P('a/d.xml'))
553 self.assertEqual(P('/a/Dot ending.').with_name('d.xml'), P('/a/d.xml'))
554 self.assertRaises(ValueError, P('').with_name, 'd.xml')
555 self.assertRaises(ValueError, P('.').with_name, 'd.xml')
556 self.assertRaises(ValueError, P('/').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400557 self.assertRaises(ValueError, P('a/b').with_name, '')
558 self.assertRaises(ValueError, P('a/b').with_name, '/c')
559 self.assertRaises(ValueError, P('a/b').with_name, 'c/')
560 self.assertRaises(ValueError, P('a/b').with_name, 'c/d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100561
562 def test_with_suffix_common(self):
563 P = self.cls
564 self.assertEqual(P('a/b').with_suffix('.gz'), P('a/b.gz'))
565 self.assertEqual(P('/a/b').with_suffix('.gz'), P('/a/b.gz'))
566 self.assertEqual(P('a/b.py').with_suffix('.gz'), P('a/b.gz'))
567 self.assertEqual(P('/a/b.py').with_suffix('.gz'), P('/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100568 # Stripping suffix.
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400569 self.assertEqual(P('a/b.py').with_suffix(''), P('a/b'))
570 self.assertEqual(P('/a/b').with_suffix(''), P('/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100571 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100572 self.assertRaises(ValueError, P('').with_suffix, '.gz')
573 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
574 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +1100575 # Invalid suffix.
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100576 self.assertRaises(ValueError, P('a/b').with_suffix, 'gz')
577 self.assertRaises(ValueError, P('a/b').with_suffix, '/')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400578 self.assertRaises(ValueError, P('a/b').with_suffix, '.')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100579 self.assertRaises(ValueError, P('a/b').with_suffix, '/.gz')
580 self.assertRaises(ValueError, P('a/b').with_suffix, 'c/d')
581 self.assertRaises(ValueError, P('a/b').with_suffix, '.c/.d')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400582 self.assertRaises(ValueError, P('a/b').with_suffix, './.d')
583 self.assertRaises(ValueError, P('a/b').with_suffix, '.d/.')
Berker Peksag423d05f2018-08-11 08:45:06 +0300584 self.assertRaises(ValueError, P('a/b').with_suffix,
585 (self.flavour.sep, 'd'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100586
587 def test_relative_to_common(self):
588 P = self.cls
589 p = P('a/b')
590 self.assertRaises(TypeError, p.relative_to)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100591 self.assertRaises(TypeError, p.relative_to, b'a')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100592 self.assertEqual(p.relative_to(P()), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100593 self.assertEqual(p.relative_to(''), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100594 self.assertEqual(p.relative_to(P('a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100595 self.assertEqual(p.relative_to('a'), P('b'))
596 self.assertEqual(p.relative_to('a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100597 self.assertEqual(p.relative_to(P('a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100598 self.assertEqual(p.relative_to('a/b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100599 # With several args.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100600 self.assertEqual(p.relative_to('a', 'b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100601 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100602 self.assertRaises(ValueError, p.relative_to, P('c'))
603 self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
604 self.assertRaises(ValueError, p.relative_to, P('a/c'))
605 self.assertRaises(ValueError, p.relative_to, P('/a'))
606 p = P('/a/b')
607 self.assertEqual(p.relative_to(P('/')), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100608 self.assertEqual(p.relative_to('/'), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100609 self.assertEqual(p.relative_to(P('/a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100610 self.assertEqual(p.relative_to('/a'), P('b'))
611 self.assertEqual(p.relative_to('/a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100612 self.assertEqual(p.relative_to(P('/a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100613 self.assertEqual(p.relative_to('/a/b'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +1100614 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100615 self.assertRaises(ValueError, p.relative_to, P('/c'))
616 self.assertRaises(ValueError, p.relative_to, P('/a/b/c'))
617 self.assertRaises(ValueError, p.relative_to, P('/a/c'))
618 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100619 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100620 self.assertRaises(ValueError, p.relative_to, P('a'))
621
622 def test_pickling_common(self):
623 P = self.cls
624 p = P('/a/b')
625 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
626 dumped = pickle.dumps(p, proto)
627 pp = pickle.loads(dumped)
628 self.assertIs(pp.__class__, p.__class__)
629 self.assertEqual(pp, p)
630 self.assertEqual(hash(pp), hash(p))
631 self.assertEqual(str(pp), str(p))
632
633
634class PurePosixPathTest(_BasePurePathTest, unittest.TestCase):
635 cls = pathlib.PurePosixPath
636
637 def test_root(self):
638 P = self.cls
639 self.assertEqual(P('/a/b').root, '/')
640 self.assertEqual(P('///a/b').root, '/')
Anthony Shaw83da9262019-01-07 07:31:29 +1100641 # POSIX special case for two leading slashes.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100642 self.assertEqual(P('//a/b').root, '//')
643
644 def test_eq(self):
645 P = self.cls
646 self.assertNotEqual(P('a/b'), P('A/b'))
647 self.assertEqual(P('/a'), P('///a'))
648 self.assertNotEqual(P('/a'), P('//a'))
649
650 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100651 P = self.cls
652 self.assertEqual(P('/').as_uri(), 'file:///')
653 self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')
654 self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')
Antoine Pitrou29eac422013-11-22 17:57:03 +0100655
656 def test_as_uri_non_ascii(self):
657 from urllib.parse import quote_from_bytes
658 P = self.cls
659 try:
660 os.fsencode('\xe9')
661 except UnicodeEncodeError:
662 self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")
Antoine Pitrou31119e42013-11-22 17:38:12 +0100663 self.assertEqual(P('/a/b\xe9').as_uri(),
664 'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))
665
666 def test_match(self):
667 P = self.cls
668 self.assertFalse(P('A.py').match('a.PY'))
669
670 def test_is_absolute(self):
671 P = self.cls
672 self.assertFalse(P().is_absolute())
673 self.assertFalse(P('a').is_absolute())
674 self.assertFalse(P('a/b/').is_absolute())
675 self.assertTrue(P('/').is_absolute())
676 self.assertTrue(P('/a').is_absolute())
677 self.assertTrue(P('/a/b/').is_absolute())
678 self.assertTrue(P('//a').is_absolute())
679 self.assertTrue(P('//a/b').is_absolute())
680
681 def test_is_reserved(self):
682 P = self.cls
683 self.assertIs(False, P('').is_reserved())
684 self.assertIs(False, P('/').is_reserved())
685 self.assertIs(False, P('/foo/bar').is_reserved())
686 self.assertIs(False, P('/dev/con/PRN/NUL').is_reserved())
687
688 def test_join(self):
689 P = self.cls
690 p = P('//a')
691 pp = p.joinpath('b')
692 self.assertEqual(pp, P('//a/b'))
693 pp = P('/a').joinpath('//c')
694 self.assertEqual(pp, P('//c'))
695 pp = P('//a').joinpath('/c')
696 self.assertEqual(pp, P('/c'))
697
698 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100699 # Basically the same as joinpath().
Antoine Pitrou31119e42013-11-22 17:38:12 +0100700 P = self.cls
701 p = P('//a')
702 pp = p / 'b'
703 self.assertEqual(pp, P('//a/b'))
704 pp = P('/a') / '//c'
705 self.assertEqual(pp, P('//c'))
706 pp = P('//a') / '/c'
707 self.assertEqual(pp, P('/c'))
708
709
710class PureWindowsPathTest(_BasePurePathTest, unittest.TestCase):
711 cls = pathlib.PureWindowsPath
712
713 equivalences = _BasePurePathTest.equivalences.copy()
714 equivalences.update({
715 'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('/', 'c:', 'a') ],
716 'c:/a': [
717 ('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),
718 ('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),
719 ],
720 '//a/b/': [ ('//a/b',) ],
721 '//a/b/c': [
722 ('//a/b', 'c'), ('//a/b/', 'c'),
723 ],
724 })
725
726 def test_str(self):
727 p = self.cls('a/b/c')
728 self.assertEqual(str(p), 'a\\b\\c')
729 p = self.cls('c:/a/b/c')
730 self.assertEqual(str(p), 'c:\\a\\b\\c')
731 p = self.cls('//a/b')
732 self.assertEqual(str(p), '\\\\a\\b\\')
733 p = self.cls('//a/b/c')
734 self.assertEqual(str(p), '\\\\a\\b\\c')
735 p = self.cls('//a/b/c/d')
736 self.assertEqual(str(p), '\\\\a\\b\\c\\d')
737
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200738 def test_str_subclass(self):
739 self._check_str_subclass('c:')
740 self._check_str_subclass('c:a')
741 self._check_str_subclass('c:a\\b.txt')
742 self._check_str_subclass('c:\\')
743 self._check_str_subclass('c:\\a')
744 self._check_str_subclass('c:\\a\\b.txt')
745 self._check_str_subclass('\\\\some\\share')
746 self._check_str_subclass('\\\\some\\share\\a')
747 self._check_str_subclass('\\\\some\\share\\a\\b.txt')
748
Antoine Pitrou31119e42013-11-22 17:38:12 +0100749 def test_eq(self):
750 P = self.cls
751 self.assertEqual(P('c:a/b'), P('c:a/b'))
752 self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))
753 self.assertNotEqual(P('c:a/b'), P('d:a/b'))
754 self.assertNotEqual(P('c:a/b'), P('c:/a/b'))
755 self.assertNotEqual(P('/a/b'), P('c:/a/b'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100756 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100757 self.assertEqual(P('a/B'), P('A/b'))
758 self.assertEqual(P('C:a/B'), P('c:A/b'))
759 self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))
760
761 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100762 P = self.cls
763 with self.assertRaises(ValueError):
764 P('/a/b').as_uri()
765 with self.assertRaises(ValueError):
766 P('c:a/b').as_uri()
767 self.assertEqual(P('c:/').as_uri(), 'file:///c:/')
768 self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')
769 self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')
770 self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')
771 self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')
772 self.assertEqual(P('//some/share/a/b.c').as_uri(),
773 'file://some/share/a/b.c')
774 self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),
775 'file://some/share/a/b%25%23c%C3%A9')
776
777 def test_match_common(self):
778 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +1100779 # Absolute patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100780 self.assertTrue(P('c:/b.py').match('/*.py'))
781 self.assertTrue(P('c:/b.py').match('c:*.py'))
782 self.assertTrue(P('c:/b.py').match('c:/*.py'))
783 self.assertFalse(P('d:/b.py').match('c:/*.py')) # wrong drive
784 self.assertFalse(P('b.py').match('/*.py'))
785 self.assertFalse(P('b.py').match('c:*.py'))
786 self.assertFalse(P('b.py').match('c:/*.py'))
787 self.assertFalse(P('c:b.py').match('/*.py'))
788 self.assertFalse(P('c:b.py').match('c:/*.py'))
789 self.assertFalse(P('/b.py').match('c:*.py'))
790 self.assertFalse(P('/b.py').match('c:/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100791 # UNC patterns.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100792 self.assertTrue(P('//some/share/a.py').match('/*.py'))
793 self.assertTrue(P('//some/share/a.py').match('//some/share/*.py'))
794 self.assertFalse(P('//other/share/a.py').match('//some/share/*.py'))
795 self.assertFalse(P('//some/share/a/b.py').match('//some/share/*.py'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100796 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100797 self.assertTrue(P('B.py').match('b.PY'))
798 self.assertTrue(P('c:/a/B.Py').match('C:/A/*.pY'))
799 self.assertTrue(P('//Some/Share/B.Py').match('//somE/sharE/*.pY'))
800
801 def test_ordering_common(self):
Anthony Shaw83da9262019-01-07 07:31:29 +1100802 # Case-insensitivity.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100803 def assertOrderedEqual(a, b):
804 self.assertLessEqual(a, b)
805 self.assertGreaterEqual(b, a)
806 P = self.cls
807 p = P('c:A/b')
808 q = P('C:a/B')
809 assertOrderedEqual(p, q)
810 self.assertFalse(p < q)
811 self.assertFalse(p > q)
812 p = P('//some/Share/A/b')
813 q = P('//Some/SHARE/a/B')
814 assertOrderedEqual(p, q)
815 self.assertFalse(p < q)
816 self.assertFalse(p > q)
817
818 def test_parts(self):
819 P = self.cls
820 p = P('c:a/b')
821 parts = p.parts
822 self.assertEqual(parts, ('c:', 'a', 'b'))
823 p = P('c:/a/b')
824 parts = p.parts
825 self.assertEqual(parts, ('c:\\', 'a', 'b'))
826 p = P('//a/b/c/d')
827 parts = p.parts
828 self.assertEqual(parts, ('\\\\a\\b\\', 'c', 'd'))
829
830 def test_parent(self):
831 # Anchored
832 P = self.cls
833 p = P('z:a/b/c')
834 self.assertEqual(p.parent, P('z:a/b'))
835 self.assertEqual(p.parent.parent, P('z:a'))
836 self.assertEqual(p.parent.parent.parent, P('z:'))
837 self.assertEqual(p.parent.parent.parent.parent, P('z:'))
838 p = P('z:/a/b/c')
839 self.assertEqual(p.parent, P('z:/a/b'))
840 self.assertEqual(p.parent.parent, P('z:/a'))
841 self.assertEqual(p.parent.parent.parent, P('z:/'))
842 self.assertEqual(p.parent.parent.parent.parent, P('z:/'))
843 p = P('//a/b/c/d')
844 self.assertEqual(p.parent, P('//a/b/c'))
845 self.assertEqual(p.parent.parent, P('//a/b'))
846 self.assertEqual(p.parent.parent.parent, P('//a/b'))
847
848 def test_parents(self):
849 # Anchored
850 P = self.cls
851 p = P('z:a/b/')
852 par = p.parents
853 self.assertEqual(len(par), 2)
854 self.assertEqual(par[0], P('z:a'))
855 self.assertEqual(par[1], P('z:'))
856 self.assertEqual(list(par), [P('z:a'), P('z:')])
857 with self.assertRaises(IndexError):
858 par[2]
859 p = P('z:/a/b/')
860 par = p.parents
861 self.assertEqual(len(par), 2)
862 self.assertEqual(par[0], P('z:/a'))
863 self.assertEqual(par[1], P('z:/'))
864 self.assertEqual(list(par), [P('z:/a'), P('z:/')])
865 with self.assertRaises(IndexError):
866 par[2]
867 p = P('//a/b/c/d')
868 par = p.parents
869 self.assertEqual(len(par), 2)
870 self.assertEqual(par[0], P('//a/b/c'))
871 self.assertEqual(par[1], P('//a/b'))
872 self.assertEqual(list(par), [P('//a/b/c'), P('//a/b')])
873 with self.assertRaises(IndexError):
874 par[2]
875
876 def test_drive(self):
877 P = self.cls
878 self.assertEqual(P('c:').drive, 'c:')
879 self.assertEqual(P('c:a/b').drive, 'c:')
880 self.assertEqual(P('c:/').drive, 'c:')
881 self.assertEqual(P('c:/a/b/').drive, 'c:')
882 self.assertEqual(P('//a/b').drive, '\\\\a\\b')
883 self.assertEqual(P('//a/b/').drive, '\\\\a\\b')
884 self.assertEqual(P('//a/b/c/d').drive, '\\\\a\\b')
885
886 def test_root(self):
887 P = self.cls
888 self.assertEqual(P('c:').root, '')
889 self.assertEqual(P('c:a/b').root, '')
890 self.assertEqual(P('c:/').root, '\\')
891 self.assertEqual(P('c:/a/b/').root, '\\')
892 self.assertEqual(P('//a/b').root, '\\')
893 self.assertEqual(P('//a/b/').root, '\\')
894 self.assertEqual(P('//a/b/c/d').root, '\\')
895
896 def test_anchor(self):
897 P = self.cls
898 self.assertEqual(P('c:').anchor, 'c:')
899 self.assertEqual(P('c:a/b').anchor, 'c:')
900 self.assertEqual(P('c:/').anchor, 'c:\\')
901 self.assertEqual(P('c:/a/b/').anchor, 'c:\\')
902 self.assertEqual(P('//a/b').anchor, '\\\\a\\b\\')
903 self.assertEqual(P('//a/b/').anchor, '\\\\a\\b\\')
904 self.assertEqual(P('//a/b/c/d').anchor, '\\\\a\\b\\')
905
906 def test_name(self):
907 P = self.cls
908 self.assertEqual(P('c:').name, '')
909 self.assertEqual(P('c:/').name, '')
910 self.assertEqual(P('c:a/b').name, 'b')
911 self.assertEqual(P('c:/a/b').name, 'b')
912 self.assertEqual(P('c:a/b.py').name, 'b.py')
913 self.assertEqual(P('c:/a/b.py').name, 'b.py')
914 self.assertEqual(P('//My.py/Share.php').name, '')
915 self.assertEqual(P('//My.py/Share.php/a/b').name, 'b')
916
917 def test_suffix(self):
918 P = self.cls
919 self.assertEqual(P('c:').suffix, '')
920 self.assertEqual(P('c:/').suffix, '')
921 self.assertEqual(P('c:a/b').suffix, '')
922 self.assertEqual(P('c:/a/b').suffix, '')
923 self.assertEqual(P('c:a/b.py').suffix, '.py')
924 self.assertEqual(P('c:/a/b.py').suffix, '.py')
925 self.assertEqual(P('c:a/.hgrc').suffix, '')
926 self.assertEqual(P('c:/a/.hgrc').suffix, '')
927 self.assertEqual(P('c:a/.hg.rc').suffix, '.rc')
928 self.assertEqual(P('c:/a/.hg.rc').suffix, '.rc')
929 self.assertEqual(P('c:a/b.tar.gz').suffix, '.gz')
930 self.assertEqual(P('c:/a/b.tar.gz').suffix, '.gz')
931 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffix, '')
932 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffix, '')
933 self.assertEqual(P('//My.py/Share.php').suffix, '')
934 self.assertEqual(P('//My.py/Share.php/a/b').suffix, '')
935
936 def test_suffixes(self):
937 P = self.cls
938 self.assertEqual(P('c:').suffixes, [])
939 self.assertEqual(P('c:/').suffixes, [])
940 self.assertEqual(P('c:a/b').suffixes, [])
941 self.assertEqual(P('c:/a/b').suffixes, [])
942 self.assertEqual(P('c:a/b.py').suffixes, ['.py'])
943 self.assertEqual(P('c:/a/b.py').suffixes, ['.py'])
944 self.assertEqual(P('c:a/.hgrc').suffixes, [])
945 self.assertEqual(P('c:/a/.hgrc').suffixes, [])
946 self.assertEqual(P('c:a/.hg.rc').suffixes, ['.rc'])
947 self.assertEqual(P('c:/a/.hg.rc').suffixes, ['.rc'])
948 self.assertEqual(P('c:a/b.tar.gz').suffixes, ['.tar', '.gz'])
949 self.assertEqual(P('c:/a/b.tar.gz').suffixes, ['.tar', '.gz'])
950 self.assertEqual(P('//My.py/Share.php').suffixes, [])
951 self.assertEqual(P('//My.py/Share.php/a/b').suffixes, [])
952 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffixes, [])
953 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffixes, [])
954
955 def test_stem(self):
956 P = self.cls
957 self.assertEqual(P('c:').stem, '')
958 self.assertEqual(P('c:.').stem, '')
959 self.assertEqual(P('c:..').stem, '..')
960 self.assertEqual(P('c:/').stem, '')
961 self.assertEqual(P('c:a/b').stem, 'b')
962 self.assertEqual(P('c:a/b.py').stem, 'b')
963 self.assertEqual(P('c:a/.hgrc').stem, '.hgrc')
964 self.assertEqual(P('c:a/.hg.rc').stem, '.hg')
965 self.assertEqual(P('c:a/b.tar.gz').stem, 'b.tar')
966 self.assertEqual(P('c:a/Some name. Ending with a dot.').stem,
967 'Some name. Ending with a dot.')
968
969 def test_with_name(self):
970 P = self.cls
971 self.assertEqual(P('c:a/b').with_name('d.xml'), P('c:a/d.xml'))
972 self.assertEqual(P('c:/a/b').with_name('d.xml'), P('c:/a/d.xml'))
973 self.assertEqual(P('c:a/Dot ending.').with_name('d.xml'), P('c:a/d.xml'))
974 self.assertEqual(P('c:/a/Dot ending.').with_name('d.xml'), P('c:/a/d.xml'))
975 self.assertRaises(ValueError, P('c:').with_name, 'd.xml')
976 self.assertRaises(ValueError, P('c:/').with_name, 'd.xml')
977 self.assertRaises(ValueError, P('//My/Share').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400978 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:')
979 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:e')
980 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:/e')
981 self.assertRaises(ValueError, P('c:a/b').with_name, '//My/Share')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100982
983 def test_with_suffix(self):
984 P = self.cls
985 self.assertEqual(P('c:a/b').with_suffix('.gz'), P('c:a/b.gz'))
986 self.assertEqual(P('c:/a/b').with_suffix('.gz'), P('c:/a/b.gz'))
987 self.assertEqual(P('c:a/b.py').with_suffix('.gz'), P('c:a/b.gz'))
988 self.assertEqual(P('c:/a/b.py').with_suffix('.gz'), P('c:/a/b.gz'))
Anthony Shaw83da9262019-01-07 07:31:29 +1100989 # Path doesn't have a "filename" component.
Antoine Pitrou31119e42013-11-22 17:38:12 +0100990 self.assertRaises(ValueError, P('').with_suffix, '.gz')
991 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
992 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
993 self.assertRaises(ValueError, P('//My/Share').with_suffix, '.gz')
Anthony Shaw83da9262019-01-07 07:31:29 +1100994 # Invalid suffix.
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100995 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'gz')
996 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/')
997 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\')
998 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:')
999 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/.gz')
1000 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\.gz')
1001 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:.gz')
1002 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c/d')
1003 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c\\d')
1004 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c/d')
1005 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c\\d')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001006
1007 def test_relative_to(self):
1008 P = self.cls
Antoine Pitrou156b3612013-12-28 19:49:04 +01001009 p = P('C:Foo/Bar')
1010 self.assertEqual(p.relative_to(P('c:')), P('Foo/Bar'))
1011 self.assertEqual(p.relative_to('c:'), P('Foo/Bar'))
1012 self.assertEqual(p.relative_to(P('c:foO')), P('Bar'))
1013 self.assertEqual(p.relative_to('c:foO'), P('Bar'))
1014 self.assertEqual(p.relative_to('c:foO/'), P('Bar'))
1015 self.assertEqual(p.relative_to(P('c:foO/baR')), P())
1016 self.assertEqual(p.relative_to('c:foO/baR'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001017 # Unrelated paths.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001018 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +01001019 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001020 self.assertRaises(ValueError, p.relative_to, P('d:'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001021 self.assertRaises(ValueError, p.relative_to, P('/'))
1022 self.assertRaises(ValueError, p.relative_to, P('Foo'))
1023 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1024 self.assertRaises(ValueError, p.relative_to, P('C:/Foo'))
1025 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Bar/Baz'))
1026 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Baz'))
1027 p = P('C:/Foo/Bar')
1028 self.assertEqual(p.relative_to(P('c:')), P('/Foo/Bar'))
1029 self.assertEqual(p.relative_to('c:'), P('/Foo/Bar'))
1030 self.assertEqual(str(p.relative_to(P('c:'))), '\\Foo\\Bar')
1031 self.assertEqual(str(p.relative_to('c:')), '\\Foo\\Bar')
1032 self.assertEqual(p.relative_to(P('c:/')), P('Foo/Bar'))
1033 self.assertEqual(p.relative_to('c:/'), P('Foo/Bar'))
1034 self.assertEqual(p.relative_to(P('c:/foO')), P('Bar'))
1035 self.assertEqual(p.relative_to('c:/foO'), P('Bar'))
1036 self.assertEqual(p.relative_to('c:/foO/'), P('Bar'))
1037 self.assertEqual(p.relative_to(P('c:/foO/baR')), P())
1038 self.assertEqual(p.relative_to('c:/foO/baR'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001039 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001040 self.assertRaises(ValueError, p.relative_to, P('C:/Baz'))
1041 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Bar/Baz'))
1042 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Baz'))
1043 self.assertRaises(ValueError, p.relative_to, P('C:Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001044 self.assertRaises(ValueError, p.relative_to, P('d:'))
1045 self.assertRaises(ValueError, p.relative_to, P('d:/'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001046 self.assertRaises(ValueError, p.relative_to, P('/'))
1047 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1048 self.assertRaises(ValueError, p.relative_to, P('//C/Foo'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001049 # UNC paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001050 p = P('//Server/Share/Foo/Bar')
1051 self.assertEqual(p.relative_to(P('//sErver/sHare')), P('Foo/Bar'))
1052 self.assertEqual(p.relative_to('//sErver/sHare'), P('Foo/Bar'))
1053 self.assertEqual(p.relative_to('//sErver/sHare/'), P('Foo/Bar'))
1054 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo')), P('Bar'))
1055 self.assertEqual(p.relative_to('//sErver/sHare/Foo'), P('Bar'))
1056 self.assertEqual(p.relative_to('//sErver/sHare/Foo/'), P('Bar'))
1057 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo/Bar')), P())
1058 self.assertEqual(p.relative_to('//sErver/sHare/Foo/Bar'), P())
Anthony Shaw83da9262019-01-07 07:31:29 +11001059 # Unrelated paths.
Antoine Pitrou156b3612013-12-28 19:49:04 +01001060 self.assertRaises(ValueError, p.relative_to, P('/Server/Share/Foo'))
1061 self.assertRaises(ValueError, p.relative_to, P('c:/Server/Share/Foo'))
1062 self.assertRaises(ValueError, p.relative_to, P('//z/Share/Foo'))
1063 self.assertRaises(ValueError, p.relative_to, P('//Server/z/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001064
1065 def test_is_absolute(self):
1066 P = self.cls
Anthony Shaw83da9262019-01-07 07:31:29 +11001067 # Under NT, only paths with both a drive and a root are absolute.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001068 self.assertFalse(P().is_absolute())
1069 self.assertFalse(P('a').is_absolute())
1070 self.assertFalse(P('a/b/').is_absolute())
1071 self.assertFalse(P('/').is_absolute())
1072 self.assertFalse(P('/a').is_absolute())
1073 self.assertFalse(P('/a/b/').is_absolute())
1074 self.assertFalse(P('c:').is_absolute())
1075 self.assertFalse(P('c:a').is_absolute())
1076 self.assertFalse(P('c:a/b/').is_absolute())
1077 self.assertTrue(P('c:/').is_absolute())
1078 self.assertTrue(P('c:/a').is_absolute())
1079 self.assertTrue(P('c:/a/b/').is_absolute())
Anthony Shaw83da9262019-01-07 07:31:29 +11001080 # UNC paths are absolute by definition.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001081 self.assertTrue(P('//a/b').is_absolute())
1082 self.assertTrue(P('//a/b/').is_absolute())
1083 self.assertTrue(P('//a/b/c').is_absolute())
1084 self.assertTrue(P('//a/b/c/d').is_absolute())
1085
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001086 def test_join(self):
1087 P = self.cls
1088 p = P('C:/a/b')
1089 pp = p.joinpath('x/y')
1090 self.assertEqual(pp, P('C:/a/b/x/y'))
1091 pp = p.joinpath('/x/y')
1092 self.assertEqual(pp, P('C:/x/y'))
1093 # Joining with a different drive => the first path is ignored, even
1094 # if the second path is relative.
1095 pp = p.joinpath('D:x/y')
1096 self.assertEqual(pp, P('D:x/y'))
1097 pp = p.joinpath('D:/x/y')
1098 self.assertEqual(pp, P('D:/x/y'))
1099 pp = p.joinpath('//host/share/x/y')
1100 self.assertEqual(pp, P('//host/share/x/y'))
1101 # Joining with the same drive => the first path is appended to if
1102 # the second path is relative.
1103 pp = p.joinpath('c:x/y')
1104 self.assertEqual(pp, P('C:/a/b/x/y'))
1105 pp = p.joinpath('c:/x/y')
1106 self.assertEqual(pp, P('C:/x/y'))
1107
1108 def test_div(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001109 # Basically the same as joinpath().
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001110 P = self.cls
1111 p = P('C:/a/b')
1112 self.assertEqual(p / 'x/y', P('C:/a/b/x/y'))
1113 self.assertEqual(p / 'x' / 'y', P('C:/a/b/x/y'))
1114 self.assertEqual(p / '/x/y', P('C:/x/y'))
1115 self.assertEqual(p / '/x' / 'y', P('C:/x/y'))
1116 # Joining with a different drive => the first path is ignored, even
1117 # if the second path is relative.
1118 self.assertEqual(p / 'D:x/y', P('D:x/y'))
1119 self.assertEqual(p / 'D:' / 'x/y', P('D:x/y'))
1120 self.assertEqual(p / 'D:/x/y', P('D:/x/y'))
1121 self.assertEqual(p / 'D:' / '/x/y', P('D:/x/y'))
1122 self.assertEqual(p / '//host/share/x/y', P('//host/share/x/y'))
1123 # Joining with the same drive => the first path is appended to if
1124 # the second path is relative.
Serhiy Storchaka010ff582013-12-06 17:25:51 +02001125 self.assertEqual(p / 'c:x/y', P('C:/a/b/x/y'))
1126 self.assertEqual(p / 'c:/x/y', P('C:/x/y'))
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001127
Antoine Pitrou31119e42013-11-22 17:38:12 +01001128 def test_is_reserved(self):
1129 P = self.cls
1130 self.assertIs(False, P('').is_reserved())
1131 self.assertIs(False, P('/').is_reserved())
1132 self.assertIs(False, P('/foo/bar').is_reserved())
1133 self.assertIs(True, P('con').is_reserved())
1134 self.assertIs(True, P('NUL').is_reserved())
1135 self.assertIs(True, P('NUL.txt').is_reserved())
1136 self.assertIs(True, P('com1').is_reserved())
1137 self.assertIs(True, P('com9.bar').is_reserved())
1138 self.assertIs(False, P('bar.com9').is_reserved())
1139 self.assertIs(True, P('lpt1').is_reserved())
1140 self.assertIs(True, P('lpt9.bar').is_reserved())
1141 self.assertIs(False, P('bar.lpt9').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001142 # Only the last component matters.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001143 self.assertIs(False, P('c:/NUL/con/baz').is_reserved())
Anthony Shaw83da9262019-01-07 07:31:29 +11001144 # UNC paths are never reserved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001145 self.assertIs(False, P('//my/share/nul/con/aux').is_reserved())
1146
Antoine Pitrou31119e42013-11-22 17:38:12 +01001147class PurePathTest(_BasePurePathTest, unittest.TestCase):
1148 cls = pathlib.PurePath
1149
1150 def test_concrete_class(self):
1151 p = self.cls('a')
1152 self.assertIs(type(p),
1153 pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath)
1154
1155 def test_different_flavours_unequal(self):
1156 p = pathlib.PurePosixPath('a')
1157 q = pathlib.PureWindowsPath('a')
1158 self.assertNotEqual(p, q)
1159
1160 def test_different_flavours_unordered(self):
1161 p = pathlib.PurePosixPath('a')
1162 q = pathlib.PureWindowsPath('a')
1163 with self.assertRaises(TypeError):
1164 p < q
1165 with self.assertRaises(TypeError):
1166 p <= q
1167 with self.assertRaises(TypeError):
1168 p > q
1169 with self.assertRaises(TypeError):
1170 p >= q
1171
1172
1173#
Anthony Shaw83da9262019-01-07 07:31:29 +11001174# Tests for the concrete classes.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001175#
1176
Anthony Shaw83da9262019-01-07 07:31:29 +11001177# Make sure any symbolic links in the base test path are resolved.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001178BASE = os.path.realpath(TESTFN)
1179join = lambda *x: os.path.join(BASE, *x)
1180rel_join = lambda *x: os.path.join(TESTFN, *x)
1181
Antoine Pitrou31119e42013-11-22 17:38:12 +01001182only_nt = unittest.skipIf(os.name != 'nt',
1183 'test requires a Windows-compatible system')
1184only_posix = unittest.skipIf(os.name == 'nt',
1185 'test requires a POSIX-compatible system')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001186
1187@only_posix
1188class PosixPathAsPureTest(PurePosixPathTest):
1189 cls = pathlib.PosixPath
1190
1191@only_nt
1192class WindowsPathAsPureTest(PureWindowsPathTest):
1193 cls = pathlib.WindowsPath
1194
Victor Stinnerd7569632016-03-11 22:53:00 +01001195 def test_owner(self):
1196 P = self.cls
1197 with self.assertRaises(NotImplementedError):
1198 P('c:/').owner()
1199
1200 def test_group(self):
1201 P = self.cls
1202 with self.assertRaises(NotImplementedError):
1203 P('c:/').group()
1204
Antoine Pitrou31119e42013-11-22 17:38:12 +01001205
1206class _BasePathTest(object):
1207 """Tests for the FS-accessing functionalities of the Path classes."""
1208
1209 # (BASE)
1210 # |
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001211 # |-- brokenLink -> non-existing
1212 # |-- dirA
1213 # | `-- linkC -> ../dirB
1214 # |-- dirB
1215 # | |-- fileB
1216 # | `-- linkD -> ../dirB
1217 # |-- dirC
1218 # | |-- dirD
1219 # | | `-- fileD
1220 # | `-- fileC
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001221 # |-- dirE # No permissions
Antoine Pitrou31119e42013-11-22 17:38:12 +01001222 # |-- fileA
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001223 # |-- linkA -> fileA
Jörg Stucked5c120f2019-05-21 19:44:40 +02001224 # |-- linkB -> dirB
1225 # `-- brokenLinkLoop -> brokenLinkLoop
Antoine Pitrou31119e42013-11-22 17:38:12 +01001226 #
1227
1228 def setUp(self):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001229 def cleanup():
1230 os.chmod(join('dirE'), 0o777)
1231 support.rmtree(BASE)
1232 self.addCleanup(cleanup)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001233 os.mkdir(BASE)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001234 os.mkdir(join('dirA'))
1235 os.mkdir(join('dirB'))
1236 os.mkdir(join('dirC'))
1237 os.mkdir(join('dirC', 'dirD'))
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001238 os.mkdir(join('dirE'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001239 with open(join('fileA'), 'wb') as f:
1240 f.write(b"this is file A\n")
1241 with open(join('dirB', 'fileB'), 'wb') as f:
1242 f.write(b"this is file B\n")
1243 with open(join('dirC', 'fileC'), 'wb') as f:
1244 f.write(b"this is file C\n")
1245 with open(join('dirC', 'dirD', 'fileD'), 'wb') as f:
1246 f.write(b"this is file D\n")
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001247 os.chmod(join('dirE'), 0)
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001248 if support.can_symlink():
Anthony Shaw83da9262019-01-07 07:31:29 +11001249 # Relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001250 os.symlink('fileA', join('linkA'))
1251 os.symlink('non-existing', join('brokenLink'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001252 self.dirlink('dirB', join('linkB'))
1253 self.dirlink(os.path.join('..', 'dirB'), join('dirA', 'linkC'))
Anthony Shaw83da9262019-01-07 07:31:29 +11001254 # This one goes upwards, creating a loop.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001255 self.dirlink(os.path.join('..', 'dirB'), join('dirB', 'linkD'))
Jörg Stucked5c120f2019-05-21 19:44:40 +02001256 # Broken symlink (pointing to itself).
1257 os.symlink('brokenLinkLoop', join('brokenLinkLoop'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001258
1259 if os.name == 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11001260 # Workaround for http://bugs.python.org/issue13772.
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001261 def dirlink(self, src, dest):
1262 os.symlink(src, dest, target_is_directory=True)
1263 else:
1264 def dirlink(self, src, dest):
1265 os.symlink(src, dest)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001266
1267 def assertSame(self, path_a, path_b):
1268 self.assertTrue(os.path.samefile(str(path_a), str(path_b)),
1269 "%r and %r don't point to the same file" %
1270 (path_a, path_b))
1271
1272 def assertFileNotFound(self, func, *args, **kwargs):
1273 with self.assertRaises(FileNotFoundError) as cm:
1274 func(*args, **kwargs)
1275 self.assertEqual(cm.exception.errno, errno.ENOENT)
1276
Steve Dower206e4c32019-09-10 15:29:28 +01001277 def assertEqualNormCase(self, path_a, path_b):
1278 self.assertEqual(os.path.normcase(path_a), os.path.normcase(path_b))
1279
Antoine Pitrou31119e42013-11-22 17:38:12 +01001280 def _test_cwd(self, p):
1281 q = self.cls(os.getcwd())
1282 self.assertEqual(p, q)
Steve Dower206e4c32019-09-10 15:29:28 +01001283 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001284 self.assertIs(type(p), type(q))
1285 self.assertTrue(p.is_absolute())
1286
1287 def test_cwd(self):
1288 p = self.cls.cwd()
1289 self._test_cwd(p)
1290
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001291 def _test_home(self, p):
1292 q = self.cls(os.path.expanduser('~'))
1293 self.assertEqual(p, q)
Steve Dower206e4c32019-09-10 15:29:28 +01001294 self.assertEqualNormCase(str(p), str(q))
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001295 self.assertIs(type(p), type(q))
1296 self.assertTrue(p.is_absolute())
1297
1298 def test_home(self):
1299 p = self.cls.home()
1300 self._test_home(p)
1301
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001302 def test_samefile(self):
1303 fileA_path = os.path.join(BASE, 'fileA')
1304 fileB_path = os.path.join(BASE, 'dirB', 'fileB')
1305 p = self.cls(fileA_path)
1306 pp = self.cls(fileA_path)
1307 q = self.cls(fileB_path)
1308 self.assertTrue(p.samefile(fileA_path))
1309 self.assertTrue(p.samefile(pp))
1310 self.assertFalse(p.samefile(fileB_path))
1311 self.assertFalse(p.samefile(q))
1312 # Test the non-existent file case
1313 non_existent = os.path.join(BASE, 'foo')
1314 r = self.cls(non_existent)
1315 self.assertRaises(FileNotFoundError, p.samefile, r)
1316 self.assertRaises(FileNotFoundError, p.samefile, non_existent)
1317 self.assertRaises(FileNotFoundError, r.samefile, p)
1318 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1319 self.assertRaises(FileNotFoundError, r.samefile, r)
1320 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1321
Antoine Pitrou31119e42013-11-22 17:38:12 +01001322 def test_empty_path(self):
1323 # The empty path points to '.'
1324 p = self.cls('')
1325 self.assertEqual(p.stat(), os.stat('.'))
1326
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001327 def test_expanduser_common(self):
1328 P = self.cls
1329 p = P('~')
1330 self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))
1331 p = P('foo')
1332 self.assertEqual(p.expanduser(), p)
1333 p = P('/~')
1334 self.assertEqual(p.expanduser(), p)
1335 p = P('../~')
1336 self.assertEqual(p.expanduser(), p)
1337 p = P(P('').absolute().anchor) / '~'
1338 self.assertEqual(p.expanduser(), p)
1339
Antoine Pitrou31119e42013-11-22 17:38:12 +01001340 def test_exists(self):
1341 P = self.cls
1342 p = P(BASE)
1343 self.assertIs(True, p.exists())
1344 self.assertIs(True, (p / 'dirA').exists())
1345 self.assertIs(True, (p / 'fileA').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001346 self.assertIs(False, (p / 'fileA' / 'bah').exists())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001347 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001348 self.assertIs(True, (p / 'linkA').exists())
1349 self.assertIs(True, (p / 'linkB').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001350 self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1351 self.assertIs(False, (p / 'linkA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001352 self.assertIs(False, (p / 'foo').exists())
1353 self.assertIs(False, P('/xyzzy').exists())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001354 self.assertIs(False, P(BASE + '\udfff').exists())
1355 self.assertIs(False, P(BASE + '\x00').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001356
1357 def test_open_common(self):
1358 p = self.cls(BASE)
1359 with (p / 'fileA').open('r') as f:
1360 self.assertIsInstance(f, io.TextIOBase)
1361 self.assertEqual(f.read(), "this is file A\n")
1362 with (p / 'fileA').open('rb') as f:
1363 self.assertIsInstance(f, io.BufferedIOBase)
1364 self.assertEqual(f.read().strip(), b"this is file A")
1365 with (p / 'fileA').open('rb', buffering=0) as f:
1366 self.assertIsInstance(f, io.RawIOBase)
1367 self.assertEqual(f.read().strip(), b"this is file A")
1368
Georg Brandlea683982014-10-01 19:12:33 +02001369 def test_read_write_bytes(self):
1370 p = self.cls(BASE)
1371 (p / 'fileA').write_bytes(b'abcdefg')
1372 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001373 # Check that trying to write str does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001374 self.assertRaises(TypeError, (p / 'fileA').write_bytes, 'somestr')
1375 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1376
1377 def test_read_write_text(self):
1378 p = self.cls(BASE)
1379 (p / 'fileA').write_text('äbcdefg', encoding='latin-1')
1380 self.assertEqual((p / 'fileA').read_text(
1381 encoding='utf-8', errors='ignore'), 'bcdefg')
Anthony Shaw83da9262019-01-07 07:31:29 +11001382 # Check that trying to write bytes does not truncate the file.
Georg Brandlea683982014-10-01 19:12:33 +02001383 self.assertRaises(TypeError, (p / 'fileA').write_text, b'somebytes')
1384 self.assertEqual((p / 'fileA').read_text(encoding='latin-1'), 'äbcdefg')
1385
Antoine Pitrou31119e42013-11-22 17:38:12 +01001386 def test_iterdir(self):
1387 P = self.cls
1388 p = P(BASE)
1389 it = p.iterdir()
1390 paths = set(it)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001391 expected = ['dirA', 'dirB', 'dirC', 'dirE', 'fileA']
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001392 if support.can_symlink():
Jörg Stucked5c120f2019-05-21 19:44:40 +02001393 expected += ['linkA', 'linkB', 'brokenLink', 'brokenLinkLoop']
Antoine Pitrou31119e42013-11-22 17:38:12 +01001394 self.assertEqual(paths, { P(BASE, q) for q in expected })
1395
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001396 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001397 def test_iterdir_symlink(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001398 # __iter__ on a symlink to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001399 P = self.cls
1400 p = P(BASE, 'linkB')
1401 paths = set(p.iterdir())
1402 expected = { P(BASE, 'linkB', q) for q in ['fileB', 'linkD'] }
1403 self.assertEqual(paths, expected)
1404
1405 def test_iterdir_nodir(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001406 # __iter__ on something that is not a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001407 p = self.cls(BASE, 'fileA')
1408 with self.assertRaises(OSError) as cm:
1409 next(p.iterdir())
1410 # ENOENT or EINVAL under Windows, ENOTDIR otherwise
Anthony Shaw83da9262019-01-07 07:31:29 +11001411 # (see issue #12802).
Antoine Pitrou31119e42013-11-22 17:38:12 +01001412 self.assertIn(cm.exception.errno, (errno.ENOTDIR,
1413 errno.ENOENT, errno.EINVAL))
1414
1415 def test_glob_common(self):
1416 def _check(glob, expected):
1417 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1418 P = self.cls
1419 p = P(BASE)
1420 it = p.glob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001421 self.assertIsInstance(it, collections.abc.Iterator)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001422 _check(it, ["fileA"])
1423 _check(p.glob("fileB"), [])
1424 _check(p.glob("dir*/file*"), ["dirB/fileB", "dirC/fileC"])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001425 if not support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001426 _check(p.glob("*A"), ['dirA', 'fileA'])
1427 else:
1428 _check(p.glob("*A"), ['dirA', 'fileA', 'linkA'])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001429 if not support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001430 _check(p.glob("*B/*"), ['dirB/fileB'])
1431 else:
1432 _check(p.glob("*B/*"), ['dirB/fileB', 'dirB/linkD',
1433 'linkB/fileB', 'linkB/linkD'])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001434 if not support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001435 _check(p.glob("*/fileB"), ['dirB/fileB'])
1436 else:
1437 _check(p.glob("*/fileB"), ['dirB/fileB', 'linkB/fileB'])
1438
1439 def test_rglob_common(self):
1440 def _check(glob, expected):
1441 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1442 P = self.cls
1443 p = P(BASE)
1444 it = p.rglob("fileA")
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001445 self.assertIsInstance(it, collections.abc.Iterator)
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001446 _check(it, ["fileA"])
1447 _check(p.rglob("fileB"), ["dirB/fileB"])
1448 _check(p.rglob("*/fileA"), [])
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001449 if not support.can_symlink():
Guido van Rossum9c39b672016-01-07 13:12:34 -08001450 _check(p.rglob("*/fileB"), ["dirB/fileB"])
1451 else:
1452 _check(p.rglob("*/fileB"), ["dirB/fileB", "dirB/linkD/fileB",
1453 "linkB/fileB", "dirA/linkC/fileB"])
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001454 _check(p.rglob("file*"), ["fileA", "dirB/fileB",
1455 "dirC/fileC", "dirC/dirD/fileD"])
Antoine Pitrou31119e42013-11-22 17:38:12 +01001456 p = P(BASE, "dirC")
1457 _check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
1458 _check(p.rglob("*/*"), ["dirC/dirD/fileD"])
1459
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001460 @support.skip_unless_symlink
Guido van Rossum69bfb152016-01-06 10:31:33 -08001461 def test_rglob_symlink_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001462 # Don't get fooled by symlink loops (Issue #26012).
Guido van Rossum69bfb152016-01-06 10:31:33 -08001463 P = self.cls
1464 p = P(BASE)
1465 given = set(p.rglob('*'))
1466 expect = {'brokenLink',
1467 'dirA', 'dirA/linkC',
1468 'dirB', 'dirB/fileB', 'dirB/linkD',
1469 'dirC', 'dirC/dirD', 'dirC/dirD/fileD', 'dirC/fileC',
1470 'dirE',
1471 'fileA',
1472 'linkA',
1473 'linkB',
Jörg Stucked5c120f2019-05-21 19:44:40 +02001474 'brokenLinkLoop',
Guido van Rossum69bfb152016-01-06 10:31:33 -08001475 }
1476 self.assertEqual(given, {p / x for x in expect})
1477
Miss Islington (bot)98a4a712019-09-12 08:07:47 -07001478 def test_glob_many_open_files(self):
1479 depth = 30
1480 P = self.cls
1481 base = P(BASE) / 'deep'
1482 p = P(base, *(['d']*depth))
1483 p.mkdir(parents=True)
1484 pattern = '/'.join(['*'] * depth)
1485 iters = [base.glob(pattern) for j in range(100)]
1486 for it in iters:
1487 self.assertEqual(next(it), p)
1488 iters = [base.rglob('d') for j in range(100)]
1489 p = base
1490 for i in range(depth):
1491 p = p / 'd'
1492 for it in iters:
1493 self.assertEqual(next(it), p)
1494
Antoine Pitrou31119e42013-11-22 17:38:12 +01001495 def test_glob_dotdot(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001496 # ".." is not special in globs.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001497 P = self.cls
1498 p = P(BASE)
1499 self.assertEqual(set(p.glob("..")), { P(BASE, "..") })
1500 self.assertEqual(set(p.glob("dirA/../file*")), { P(BASE, "dirA/../fileA") })
1501 self.assertEqual(set(p.glob("../xyzzy")), set())
1502
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001503
Steve Dower98eb3602016-11-09 12:58:17 -08001504 def _check_resolve(self, p, expected, strict=True):
1505 q = p.resolve(strict)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001506 self.assertEqual(q, expected)
1507
Anthony Shaw83da9262019-01-07 07:31:29 +11001508 # This can be used to check both relative and absolute resolutions.
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001509 _check_resolve_relative = _check_resolve_absolute = _check_resolve
Antoine Pitrou31119e42013-11-22 17:38:12 +01001510
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001511 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001512 def test_resolve_common(self):
1513 P = self.cls
1514 p = P(BASE, 'foo')
1515 with self.assertRaises(OSError) as cm:
Steve Dower98eb3602016-11-09 12:58:17 -08001516 p.resolve(strict=True)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001517 self.assertEqual(cm.exception.errno, errno.ENOENT)
Steve Dower98eb3602016-11-09 12:58:17 -08001518 # Non-strict
Steve Dower206e4c32019-09-10 15:29:28 +01001519 self.assertEqualNormCase(str(p.resolve(strict=False)),
1520 os.path.join(BASE, 'foo'))
Steve Dower98eb3602016-11-09 12:58:17 -08001521 p = P(BASE, 'foo', 'in', 'spam')
Steve Dower206e4c32019-09-10 15:29:28 +01001522 self.assertEqualNormCase(str(p.resolve(strict=False)),
1523 os.path.join(BASE, 'foo', 'in', 'spam'))
Steve Dower98eb3602016-11-09 12:58:17 -08001524 p = P(BASE, '..', 'foo', 'in', 'spam')
Steve Dower206e4c32019-09-10 15:29:28 +01001525 self.assertEqualNormCase(str(p.resolve(strict=False)),
1526 os.path.abspath(os.path.join('foo', 'in', 'spam')))
Anthony Shaw83da9262019-01-07 07:31:29 +11001527 # These are all relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001528 p = P(BASE, 'dirB', 'fileB')
1529 self._check_resolve_relative(p, p)
1530 p = P(BASE, 'linkA')
1531 self._check_resolve_relative(p, P(BASE, 'fileA'))
1532 p = P(BASE, 'dirA', 'linkC', 'fileB')
1533 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1534 p = P(BASE, 'dirB', 'linkD', 'fileB')
1535 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001536 # Non-strict
1537 p = P(BASE, 'dirA', 'linkC', 'fileB', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001538 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB', 'foo', 'in',
1539 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001540 p = P(BASE, 'dirA', 'linkC', '..', 'foo', 'in', 'spam')
1541 if os.name == 'nt':
1542 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1543 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001544 self._check_resolve_relative(p, P(BASE, 'dirA', 'foo', 'in',
1545 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001546 else:
1547 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1548 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001549 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Anthony Shaw83da9262019-01-07 07:31:29 +11001550 # Now create absolute symlinks.
Steve Dower0cd63912018-12-10 18:52:57 -08001551 d = support._longpath(tempfile.mkdtemp(suffix='-dirD', dir=os.getcwd()))
Victor Stinnerec864692014-07-21 19:19:05 +02001552 self.addCleanup(support.rmtree, d)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001553 os.symlink(os.path.join(d), join('dirA', 'linkX'))
1554 os.symlink(join('dirB'), os.path.join(d, 'linkY'))
1555 p = P(BASE, 'dirA', 'linkX', 'linkY', 'fileB')
1556 self._check_resolve_absolute(p, P(BASE, 'dirB', 'fileB'))
Steve Dower98eb3602016-11-09 12:58:17 -08001557 # Non-strict
1558 p = P(BASE, 'dirA', 'linkX', 'linkY', 'foo', 'in', 'spam')
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001559 self._check_resolve_relative(p, P(BASE, 'dirB', 'foo', 'in', 'spam'),
1560 False)
Steve Dower98eb3602016-11-09 12:58:17 -08001561 p = P(BASE, 'dirA', 'linkX', 'linkY', '..', 'foo', 'in', 'spam')
1562 if os.name == 'nt':
1563 # In Windows, if linkY points to dirB, 'dirA\linkY\..'
1564 # resolves to 'dirA' without resolving linkY first.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001565 self._check_resolve_relative(p, P(d, 'foo', 'in', 'spam'), False)
Steve Dower98eb3602016-11-09 12:58:17 -08001566 else:
1567 # In Posix, if linkY points to dirB, 'dirA/linkY/..'
1568 # resolves to 'dirB/..' first before resolving to parent of dirB.
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001569 self._check_resolve_relative(p, P(BASE, 'foo', 'in', 'spam'), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001570
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001571 @support.skip_unless_symlink
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001572 def test_resolve_dot(self):
1573 # See https://bitbucket.org/pitrou/pathlib/issue/9/pathresolve-fails-on-complex-symlinks
1574 p = self.cls(BASE)
1575 self.dirlink('.', join('0'))
Antoine Pitroucc157512013-12-03 17:13:13 +01001576 self.dirlink(os.path.join('0', '0'), join('1'))
1577 self.dirlink(os.path.join('1', '1'), join('2'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001578 q = p / '2'
Steve Dower98eb3602016-11-09 12:58:17 -08001579 self.assertEqual(q.resolve(strict=True), p)
1580 r = q / '3' / '4'
1581 self.assertRaises(FileNotFoundError, r.resolve, strict=True)
1582 # Non-strict
Antoine Pietriadd98eb2017-06-07 17:29:17 +02001583 self.assertEqual(r.resolve(strict=False), p / '3' / '4')
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001584
Antoine Pitrou31119e42013-11-22 17:38:12 +01001585 def test_with(self):
1586 p = self.cls(BASE)
1587 it = p.iterdir()
1588 it2 = p.iterdir()
1589 next(it2)
1590 with p:
1591 pass
Anthony Shaw83da9262019-01-07 07:31:29 +11001592 # I/O operation on closed path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001593 self.assertRaises(ValueError, next, it)
1594 self.assertRaises(ValueError, next, it2)
1595 self.assertRaises(ValueError, p.open)
1596 self.assertRaises(ValueError, p.resolve)
1597 self.assertRaises(ValueError, p.absolute)
1598 self.assertRaises(ValueError, p.__enter__)
1599
1600 def test_chmod(self):
1601 p = self.cls(BASE) / 'fileA'
1602 mode = p.stat().st_mode
Anthony Shaw83da9262019-01-07 07:31:29 +11001603 # Clear writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001604 new_mode = mode & ~0o222
1605 p.chmod(new_mode)
1606 self.assertEqual(p.stat().st_mode, new_mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11001607 # Set writable bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001608 new_mode = mode | 0o222
1609 p.chmod(new_mode)
1610 self.assertEqual(p.stat().st_mode, new_mode)
1611
Anthony Shaw83da9262019-01-07 07:31:29 +11001612 # XXX also need a test for lchmod.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001613
1614 def test_stat(self):
1615 p = self.cls(BASE) / 'fileA'
1616 st = p.stat()
1617 self.assertEqual(p.stat(), st)
Anthony Shaw83da9262019-01-07 07:31:29 +11001618 # Change file mode by flipping write bit.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001619 p.chmod(st.st_mode ^ 0o222)
1620 self.addCleanup(p.chmod, st.st_mode)
1621 self.assertNotEqual(p.stat(), st)
1622
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001623 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001624 def test_lstat(self):
1625 p = self.cls(BASE)/ 'linkA'
1626 st = p.stat()
1627 self.assertNotEqual(st, p.lstat())
1628
1629 def test_lstat_nosymlink(self):
1630 p = self.cls(BASE) / 'fileA'
1631 st = p.stat()
1632 self.assertEqual(st, p.lstat())
1633
1634 @unittest.skipUnless(pwd, "the pwd module is needed for this test")
1635 def test_owner(self):
1636 p = self.cls(BASE) / 'fileA'
1637 uid = p.stat().st_uid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001638 try:
1639 name = pwd.getpwuid(uid).pw_name
1640 except KeyError:
1641 self.skipTest(
1642 "user %d doesn't have an entry in the system database" % uid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001643 self.assertEqual(name, p.owner())
1644
1645 @unittest.skipUnless(grp, "the grp module is needed for this test")
1646 def test_group(self):
1647 p = self.cls(BASE) / 'fileA'
1648 gid = p.stat().st_gid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001649 try:
1650 name = grp.getgrgid(gid).gr_name
1651 except KeyError:
1652 self.skipTest(
1653 "group %d doesn't have an entry in the system database" % gid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001654 self.assertEqual(name, p.group())
1655
1656 def test_unlink(self):
1657 p = self.cls(BASE) / 'fileA'
1658 p.unlink()
1659 self.assertFileNotFound(p.stat)
1660 self.assertFileNotFound(p.unlink)
1661
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001662 def test_unlink_missing_ok(self):
1663 p = self.cls(BASE) / 'fileAAA'
1664 self.assertFileNotFound(p.unlink)
1665 p.unlink(missing_ok=True)
1666
Antoine Pitrou31119e42013-11-22 17:38:12 +01001667 def test_rmdir(self):
1668 p = self.cls(BASE) / 'dirA'
1669 for q in p.iterdir():
1670 q.unlink()
1671 p.rmdir()
1672 self.assertFileNotFound(p.stat)
1673 self.assertFileNotFound(p.unlink)
1674
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001675 def test_link_to(self):
1676 P = self.cls(BASE)
1677 p = P / 'fileA'
1678 size = p.stat().st_size
1679 # linking to another path.
1680 q = P / 'dirA' / 'fileAA'
1681 try:
1682 p.link_to(q)
1683 except PermissionError as e:
1684 self.skipTest('os.link(): %s' % e)
1685 self.assertEqual(q.stat().st_size, size)
1686 self.assertEqual(os.path.samefile(p, q), True)
1687 self.assertTrue(p.stat)
1688 # Linking to a str of a relative path.
1689 r = rel_join('fileAAA')
1690 q.link_to(r)
1691 self.assertEqual(os.stat(r).st_size, size)
1692 self.assertTrue(q.stat)
1693
Antoine Pitrou31119e42013-11-22 17:38:12 +01001694 def test_rename(self):
1695 P = self.cls(BASE)
1696 p = P / 'fileA'
1697 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11001698 # Renaming to another path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001699 q = P / 'dirA' / 'fileAA'
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001700 renamed_p = p.rename(q)
1701 self.assertEqual(renamed_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001702 self.assertEqual(q.stat().st_size, size)
1703 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11001704 # Renaming to a str of a relative path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001705 r = rel_join('fileAAA')
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001706 renamed_q = q.rename(r)
1707 self.assertEqual(renamed_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001708 self.assertEqual(os.stat(r).st_size, size)
1709 self.assertFileNotFound(q.stat)
1710
1711 def test_replace(self):
1712 P = self.cls(BASE)
1713 p = P / 'fileA'
1714 size = p.stat().st_size
Anthony Shaw83da9262019-01-07 07:31:29 +11001715 # Replacing a non-existing path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001716 q = P / 'dirA' / 'fileAA'
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001717 replaced_p = p.replace(q)
1718 self.assertEqual(replaced_p, q)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001719 self.assertEqual(q.stat().st_size, size)
1720 self.assertFileNotFound(p.stat)
Anthony Shaw83da9262019-01-07 07:31:29 +11001721 # Replacing another (existing) path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001722 r = rel_join('dirB', 'fileB')
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001723 replaced_q = q.replace(r)
1724 self.assertEqual(replaced_q, self.cls(r))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001725 self.assertEqual(os.stat(r).st_size, size)
1726 self.assertFileNotFound(q.stat)
1727
1728 def test_touch_common(self):
1729 P = self.cls(BASE)
1730 p = P / 'newfileA'
1731 self.assertFalse(p.exists())
1732 p.touch()
1733 self.assertTrue(p.exists())
Antoine Pitrou0f575642013-11-22 23:20:08 +01001734 st = p.stat()
1735 old_mtime = st.st_mtime
1736 old_mtime_ns = st.st_mtime_ns
Antoine Pitrou31119e42013-11-22 17:38:12 +01001737 # Rewind the mtime sufficiently far in the past to work around
1738 # filesystem-specific timestamp granularity.
1739 os.utime(str(p), (old_mtime - 10, old_mtime - 10))
Anthony Shaw83da9262019-01-07 07:31:29 +11001740 # The file mtime should be refreshed by calling touch() again.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001741 p.touch()
Antoine Pitrou0f575642013-11-22 23:20:08 +01001742 st = p.stat()
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001743 self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)
1744 self.assertGreaterEqual(st.st_mtime, old_mtime)
Anthony Shaw83da9262019-01-07 07:31:29 +11001745 # Now with exist_ok=False.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001746 p = P / 'newfileB'
1747 self.assertFalse(p.exists())
1748 p.touch(mode=0o700, exist_ok=False)
1749 self.assertTrue(p.exists())
1750 self.assertRaises(OSError, p.touch, exist_ok=False)
1751
Antoine Pitrou8b784932013-11-23 14:52:39 +01001752 def test_touch_nochange(self):
1753 P = self.cls(BASE)
1754 p = P / 'fileA'
1755 p.touch()
1756 with p.open('rb') as f:
1757 self.assertEqual(f.read().strip(), b"this is file A")
1758
Antoine Pitrou31119e42013-11-22 17:38:12 +01001759 def test_mkdir(self):
1760 P = self.cls(BASE)
1761 p = P / 'newdirA'
1762 self.assertFalse(p.exists())
1763 p.mkdir()
1764 self.assertTrue(p.exists())
1765 self.assertTrue(p.is_dir())
1766 with self.assertRaises(OSError) as cm:
1767 p.mkdir()
1768 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001769
1770 def test_mkdir_parents(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001771 # Creating a chain of directories.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001772 p = self.cls(BASE, 'newdirB', 'newdirC')
1773 self.assertFalse(p.exists())
1774 with self.assertRaises(OSError) as cm:
1775 p.mkdir()
1776 self.assertEqual(cm.exception.errno, errno.ENOENT)
1777 p.mkdir(parents=True)
1778 self.assertTrue(p.exists())
1779 self.assertTrue(p.is_dir())
1780 with self.assertRaises(OSError) as cm:
1781 p.mkdir(parents=True)
1782 self.assertEqual(cm.exception.errno, errno.EEXIST)
Anthony Shaw83da9262019-01-07 07:31:29 +11001783 # Test `mode` arg.
1784 mode = stat.S_IMODE(p.stat().st_mode) # Default mode.
Antoine Pitrou0048c982013-12-16 20:22:37 +01001785 p = self.cls(BASE, 'newdirD', 'newdirE')
1786 p.mkdir(0o555, parents=True)
1787 self.assertTrue(p.exists())
1788 self.assertTrue(p.is_dir())
1789 if os.name != 'nt':
Anthony Shaw83da9262019-01-07 07:31:29 +11001790 # The directory's permissions follow the mode argument.
Gregory P. Smithb599c612014-01-20 01:10:33 -08001791 self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)
Anthony Shaw83da9262019-01-07 07:31:29 +11001792 # The parent's permissions follow the default process settings.
Antoine Pitrou0048c982013-12-16 20:22:37 +01001793 self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001794
Barry Warsaw7c549c42014-08-05 11:28:12 -04001795 def test_mkdir_exist_ok(self):
1796 p = self.cls(BASE, 'dirB')
1797 st_ctime_first = p.stat().st_ctime
1798 self.assertTrue(p.exists())
1799 self.assertTrue(p.is_dir())
1800 with self.assertRaises(FileExistsError) as cm:
1801 p.mkdir()
1802 self.assertEqual(cm.exception.errno, errno.EEXIST)
1803 p.mkdir(exist_ok=True)
1804 self.assertTrue(p.exists())
1805 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1806
1807 def test_mkdir_exist_ok_with_parent(self):
1808 p = self.cls(BASE, 'dirC')
1809 self.assertTrue(p.exists())
1810 with self.assertRaises(FileExistsError) as cm:
1811 p.mkdir()
1812 self.assertEqual(cm.exception.errno, errno.EEXIST)
1813 p = p / 'newdirC'
1814 p.mkdir(parents=True)
1815 st_ctime_first = p.stat().st_ctime
1816 self.assertTrue(p.exists())
1817 with self.assertRaises(FileExistsError) as cm:
1818 p.mkdir(parents=True)
1819 self.assertEqual(cm.exception.errno, errno.EEXIST)
1820 p.mkdir(parents=True, exist_ok=True)
1821 self.assertTrue(p.exists())
1822 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1823
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001824 def test_mkdir_exist_ok_root(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11001825 # Issue #25803: A drive root could raise PermissionError on Windows.
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001826 self.cls('/').resolve().mkdir(exist_ok=True)
1827 self.cls('/').resolve().mkdir(parents=True, exist_ok=True)
1828
Anthony Shaw83da9262019-01-07 07:31:29 +11001829 @only_nt # XXX: not sure how to test this on POSIX.
Steve Dowerd3c48532017-02-04 14:54:56 -08001830 def test_mkdir_with_unknown_drive(self):
1831 for d in 'ZYXWVUTSRQPONMLKJIHGFEDCBA':
1832 p = self.cls(d + ':\\')
1833 if not p.is_dir():
1834 break
1835 else:
1836 self.skipTest("cannot find a drive that doesn't exist")
1837 with self.assertRaises(OSError):
1838 (p / 'child' / 'path').mkdir(parents=True)
1839
Barry Warsaw7c549c42014-08-05 11:28:12 -04001840 def test_mkdir_with_child_file(self):
1841 p = self.cls(BASE, 'dirB', 'fileB')
1842 self.assertTrue(p.exists())
1843 # An exception is raised when the last path component is an existing
1844 # regular file, regardless of whether exist_ok is true or not.
1845 with self.assertRaises(FileExistsError) as cm:
1846 p.mkdir(parents=True)
1847 self.assertEqual(cm.exception.errno, errno.EEXIST)
1848 with self.assertRaises(FileExistsError) as cm:
1849 p.mkdir(parents=True, exist_ok=True)
1850 self.assertEqual(cm.exception.errno, errno.EEXIST)
1851
1852 def test_mkdir_no_parents_file(self):
1853 p = self.cls(BASE, 'fileA')
1854 self.assertTrue(p.exists())
1855 # An exception is raised when the last path component is an existing
1856 # regular file, regardless of whether exist_ok is true or not.
1857 with self.assertRaises(FileExistsError) as cm:
1858 p.mkdir()
1859 self.assertEqual(cm.exception.errno, errno.EEXIST)
1860 with self.assertRaises(FileExistsError) as cm:
1861 p.mkdir(exist_ok=True)
1862 self.assertEqual(cm.exception.errno, errno.EEXIST)
1863
Armin Rigo22a594a2017-04-13 20:08:15 +02001864 def test_mkdir_concurrent_parent_creation(self):
1865 for pattern_num in range(32):
1866 p = self.cls(BASE, 'dirCPC%d' % pattern_num)
1867 self.assertFalse(p.exists())
1868
1869 def my_mkdir(path, mode=0o777):
1870 path = str(path)
1871 # Emulate another process that would create the directory
1872 # just before we try to create it ourselves. We do it
1873 # in all possible pattern combinations, assuming that this
1874 # function is called at most 5 times (dirCPC/dir1/dir2,
1875 # dirCPC/dir1, dirCPC, dirCPC/dir1, dirCPC/dir1/dir2).
1876 if pattern.pop():
Anthony Shaw83da9262019-01-07 07:31:29 +11001877 os.mkdir(path, mode) # From another process.
Armin Rigo22a594a2017-04-13 20:08:15 +02001878 concurrently_created.add(path)
Anthony Shaw83da9262019-01-07 07:31:29 +11001879 os.mkdir(path, mode) # Our real call.
Armin Rigo22a594a2017-04-13 20:08:15 +02001880
1881 pattern = [bool(pattern_num & (1 << n)) for n in range(5)]
1882 concurrently_created = set()
1883 p12 = p / 'dir1' / 'dir2'
1884 try:
1885 with mock.patch("pathlib._normal_accessor.mkdir", my_mkdir):
1886 p12.mkdir(parents=True, exist_ok=False)
1887 except FileExistsError:
1888 self.assertIn(str(p12), concurrently_created)
1889 else:
1890 self.assertNotIn(str(p12), concurrently_created)
1891 self.assertTrue(p.exists())
1892
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001893 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01001894 def test_symlink_to(self):
1895 P = self.cls(BASE)
1896 target = P / 'fileA'
Anthony Shaw83da9262019-01-07 07:31:29 +11001897 # Symlinking a path target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001898 link = P / 'dirA' / 'linkAA'
1899 link.symlink_to(target)
1900 self.assertEqual(link.stat(), target.stat())
1901 self.assertNotEqual(link.lstat(), target.stat())
Anthony Shaw83da9262019-01-07 07:31:29 +11001902 # Symlinking a str target.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001903 link = P / 'dirA' / 'linkAAA'
1904 link.symlink_to(str(target))
1905 self.assertEqual(link.stat(), target.stat())
1906 self.assertNotEqual(link.lstat(), target.stat())
1907 self.assertFalse(link.is_dir())
Anthony Shaw83da9262019-01-07 07:31:29 +11001908 # Symlinking to a directory.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001909 target = P / 'dirB'
1910 link = P / 'dirA' / 'linkAAAA'
1911 link.symlink_to(target, target_is_directory=True)
1912 self.assertEqual(link.stat(), target.stat())
1913 self.assertNotEqual(link.lstat(), target.stat())
1914 self.assertTrue(link.is_dir())
1915 self.assertTrue(list(link.iterdir()))
1916
1917 def test_is_dir(self):
1918 P = self.cls(BASE)
1919 self.assertTrue((P / 'dirA').is_dir())
1920 self.assertFalse((P / 'fileA').is_dir())
1921 self.assertFalse((P / 'non-existing').is_dir())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001922 self.assertFalse((P / 'fileA' / 'bah').is_dir())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001923 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001924 self.assertFalse((P / 'linkA').is_dir())
1925 self.assertTrue((P / 'linkB').is_dir())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001926 self.assertFalse((P/ 'brokenLink').is_dir(), False)
1927 self.assertIs((P / 'dirA\udfff').is_dir(), False)
1928 self.assertIs((P / 'dirA\x00').is_dir(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001929
1930 def test_is_file(self):
1931 P = self.cls(BASE)
1932 self.assertTrue((P / 'fileA').is_file())
1933 self.assertFalse((P / 'dirA').is_file())
1934 self.assertFalse((P / 'non-existing').is_file())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001935 self.assertFalse((P / 'fileA' / 'bah').is_file())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001936 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001937 self.assertTrue((P / 'linkA').is_file())
1938 self.assertFalse((P / 'linkB').is_file())
1939 self.assertFalse((P/ 'brokenLink').is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001940 self.assertIs((P / 'fileA\udfff').is_file(), False)
1941 self.assertIs((P / 'fileA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001942
Cooper Lees173ff4a2017-08-01 15:35:45 -07001943 @only_posix
1944 def test_is_mount(self):
1945 P = self.cls(BASE)
Anthony Shaw83da9262019-01-07 07:31:29 +11001946 R = self.cls('/') # TODO: Work out Windows.
Cooper Lees173ff4a2017-08-01 15:35:45 -07001947 self.assertFalse((P / 'fileA').is_mount())
1948 self.assertFalse((P / 'dirA').is_mount())
1949 self.assertFalse((P / 'non-existing').is_mount())
1950 self.assertFalse((P / 'fileA' / 'bah').is_mount())
1951 self.assertTrue(R.is_mount())
1952 if support.can_symlink():
1953 self.assertFalse((P / 'linkA').is_mount())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001954 self.assertIs(self.cls('/\udfff').is_mount(), False)
1955 self.assertIs(self.cls('/\x00').is_mount(), False)
Cooper Lees173ff4a2017-08-01 15:35:45 -07001956
Antoine Pitrou31119e42013-11-22 17:38:12 +01001957 def test_is_symlink(self):
1958 P = self.cls(BASE)
1959 self.assertFalse((P / 'fileA').is_symlink())
1960 self.assertFalse((P / 'dirA').is_symlink())
1961 self.assertFalse((P / 'non-existing').is_symlink())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001962 self.assertFalse((P / 'fileA' / 'bah').is_symlink())
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07001963 if support.can_symlink():
Antoine Pitrou31119e42013-11-22 17:38:12 +01001964 self.assertTrue((P / 'linkA').is_symlink())
1965 self.assertTrue((P / 'linkB').is_symlink())
1966 self.assertTrue((P/ 'brokenLink').is_symlink())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001967 self.assertIs((P / 'fileA\udfff').is_file(), False)
1968 self.assertIs((P / 'fileA\x00').is_file(), False)
1969 if support.can_symlink():
1970 self.assertIs((P / 'linkA\udfff').is_file(), False)
1971 self.assertIs((P / 'linkA\x00').is_file(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001972
1973 def test_is_fifo_false(self):
1974 P = self.cls(BASE)
1975 self.assertFalse((P / 'fileA').is_fifo())
1976 self.assertFalse((P / 'dirA').is_fifo())
1977 self.assertFalse((P / 'non-existing').is_fifo())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001978 self.assertFalse((P / 'fileA' / 'bah').is_fifo())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001979 self.assertIs((P / 'fileA\udfff').is_fifo(), False)
1980 self.assertIs((P / 'fileA\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001981
1982 @unittest.skipUnless(hasattr(os, "mkfifo"), "os.mkfifo() required")
1983 def test_is_fifo_true(self):
1984 P = self.cls(BASE, 'myfifo')
xdegaye92c2ca72017-11-12 17:31:07 +01001985 try:
1986 os.mkfifo(str(P))
1987 except PermissionError as e:
1988 self.skipTest('os.mkfifo(): %s' % e)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001989 self.assertTrue(P.is_fifo())
1990 self.assertFalse(P.is_socket())
1991 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001992 self.assertIs(self.cls(BASE, 'myfifo\udfff').is_fifo(), False)
1993 self.assertIs(self.cls(BASE, 'myfifo\x00').is_fifo(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001994
1995 def test_is_socket_false(self):
1996 P = self.cls(BASE)
1997 self.assertFalse((P / 'fileA').is_socket())
1998 self.assertFalse((P / 'dirA').is_socket())
1999 self.assertFalse((P / 'non-existing').is_socket())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002000 self.assertFalse((P / 'fileA' / 'bah').is_socket())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002001 self.assertIs((P / 'fileA\udfff').is_socket(), False)
2002 self.assertIs((P / 'fileA\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002003
2004 @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required")
2005 def test_is_socket_true(self):
2006 P = self.cls(BASE, 'mysock')
Antoine Pitrou330ce592013-11-22 18:05:06 +01002007 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002008 self.addCleanup(sock.close)
Antoine Pitrou330ce592013-11-22 18:05:06 +01002009 try:
2010 sock.bind(str(P))
2011 except OSError as e:
Xavier de Gayee88ed052016-12-14 11:52:28 +01002012 if (isinstance(e, PermissionError) or
2013 "AF_UNIX path too long" in str(e)):
Antoine Pitrou330ce592013-11-22 18:05:06 +01002014 self.skipTest("cannot bind Unix socket: " + str(e))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002015 self.assertTrue(P.is_socket())
2016 self.assertFalse(P.is_fifo())
2017 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002018 self.assertIs(self.cls(BASE, 'mysock\udfff').is_socket(), False)
2019 self.assertIs(self.cls(BASE, 'mysock\x00').is_socket(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002020
2021 def test_is_block_device_false(self):
2022 P = self.cls(BASE)
2023 self.assertFalse((P / 'fileA').is_block_device())
2024 self.assertFalse((P / 'dirA').is_block_device())
2025 self.assertFalse((P / 'non-existing').is_block_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002026 self.assertFalse((P / 'fileA' / 'bah').is_block_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002027 self.assertIs((P / 'fileA\udfff').is_block_device(), False)
2028 self.assertIs((P / 'fileA\x00').is_block_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002029
2030 def test_is_char_device_false(self):
2031 P = self.cls(BASE)
2032 self.assertFalse((P / 'fileA').is_char_device())
2033 self.assertFalse((P / 'dirA').is_char_device())
2034 self.assertFalse((P / 'non-existing').is_char_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01002035 self.assertFalse((P / 'fileA' / 'bah').is_char_device())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002036 self.assertIs((P / 'fileA\udfff').is_char_device(), False)
2037 self.assertIs((P / 'fileA\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002038
2039 def test_is_char_device_true(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002040 # Under Unix, /dev/null should generally be a char device.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002041 P = self.cls('/dev/null')
2042 if not P.exists():
2043 self.skipTest("/dev/null required")
2044 self.assertTrue(P.is_char_device())
2045 self.assertFalse(P.is_block_device())
2046 self.assertFalse(P.is_file())
Serhiy Storchaka0185f342018-09-18 11:28:51 +03002047 self.assertIs(self.cls('/dev/null\udfff').is_char_device(), False)
2048 self.assertIs(self.cls('/dev/null\x00').is_char_device(), False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002049
2050 def test_pickling_common(self):
2051 p = self.cls(BASE, 'fileA')
2052 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
2053 dumped = pickle.dumps(p, proto)
2054 pp = pickle.loads(dumped)
2055 self.assertEqual(pp.stat(), p.stat())
2056
2057 def test_parts_interning(self):
2058 P = self.cls
2059 p = P('/usr/bin/foo')
2060 q = P('/usr/local/bin')
2061 # 'usr'
2062 self.assertIs(p.parts[1], q.parts[1])
2063 # 'bin'
2064 self.assertIs(p.parts[2], q.parts[3])
2065
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002066 def _check_complex_symlinks(self, link0_target):
Anthony Shaw83da9262019-01-07 07:31:29 +11002067 # Test solving a non-looping chain of symlinks (issue #19887).
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002068 P = self.cls(BASE)
2069 self.dirlink(os.path.join('link0', 'link0'), join('link1'))
2070 self.dirlink(os.path.join('link1', 'link1'), join('link2'))
2071 self.dirlink(os.path.join('link2', 'link2'), join('link3'))
2072 self.dirlink(link0_target, join('link0'))
2073
Anthony Shaw83da9262019-01-07 07:31:29 +11002074 # Resolve absolute paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002075 p = (P / 'link0').resolve()
2076 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002077 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002078 p = (P / 'link1').resolve()
2079 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002080 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002081 p = (P / 'link2').resolve()
2082 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002083 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002084 p = (P / 'link3').resolve()
2085 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002086 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002087
Anthony Shaw83da9262019-01-07 07:31:29 +11002088 # Resolve relative paths.
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002089 old_path = os.getcwd()
2090 os.chdir(BASE)
2091 try:
2092 p = self.cls('link0').resolve()
2093 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002094 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002095 p = self.cls('link1').resolve()
2096 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002097 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002098 p = self.cls('link2').resolve()
2099 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002100 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002101 p = self.cls('link3').resolve()
2102 self.assertEqual(p, P)
Steve Dower206e4c32019-09-10 15:29:28 +01002103 self.assertEqualNormCase(str(p), BASE)
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002104 finally:
2105 os.chdir(old_path)
2106
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002107 @support.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002108 def test_complex_symlinks_absolute(self):
2109 self._check_complex_symlinks(BASE)
2110
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002111 @support.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002112 def test_complex_symlinks_relative(self):
2113 self._check_complex_symlinks('.')
2114
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002115 @support.skip_unless_symlink
Antoine Pitrouc274fd22013-12-16 19:57:41 +01002116 def test_complex_symlinks_relative_dot_dot(self):
2117 self._check_complex_symlinks(os.path.join('dirA', '..'))
2118
Antoine Pitrou31119e42013-11-22 17:38:12 +01002119
2120class PathTest(_BasePathTest, unittest.TestCase):
2121 cls = pathlib.Path
2122
2123 def test_concrete_class(self):
2124 p = self.cls('a')
2125 self.assertIs(type(p),
2126 pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath)
2127
2128 def test_unsupported_flavour(self):
2129 if os.name == 'nt':
2130 self.assertRaises(NotImplementedError, pathlib.PosixPath)
2131 else:
2132 self.assertRaises(NotImplementedError, pathlib.WindowsPath)
2133
Berker Peksag4a208e42016-01-30 17:50:48 +02002134 def test_glob_empty_pattern(self):
2135 p = self.cls()
2136 with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
2137 list(p.glob(''))
2138
Antoine Pitrou31119e42013-11-22 17:38:12 +01002139
2140@only_posix
2141class PosixPathTest(_BasePathTest, unittest.TestCase):
2142 cls = pathlib.PosixPath
2143
Steve Dower98eb3602016-11-09 12:58:17 -08002144 def _check_symlink_loop(self, *args, strict=True):
Antoine Pitrou31119e42013-11-22 17:38:12 +01002145 path = self.cls(*args)
2146 with self.assertRaises(RuntimeError):
Steve Dower98eb3602016-11-09 12:58:17 -08002147 print(path.resolve(strict))
Antoine Pitrou31119e42013-11-22 17:38:12 +01002148
2149 def test_open_mode(self):
2150 old_mask = os.umask(0)
2151 self.addCleanup(os.umask, old_mask)
2152 p = self.cls(BASE)
2153 with (p / 'new_file').open('wb'):
2154 pass
2155 st = os.stat(join('new_file'))
2156 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2157 os.umask(0o022)
2158 with (p / 'other_new_file').open('wb'):
2159 pass
2160 st = os.stat(join('other_new_file'))
2161 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2162
2163 def test_touch_mode(self):
2164 old_mask = os.umask(0)
2165 self.addCleanup(os.umask, old_mask)
2166 p = self.cls(BASE)
2167 (p / 'new_file').touch()
2168 st = os.stat(join('new_file'))
2169 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2170 os.umask(0o022)
2171 (p / 'other_new_file').touch()
2172 st = os.stat(join('other_new_file'))
2173 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2174 (p / 'masked_new_file').touch(mode=0o750)
2175 st = os.stat(join('masked_new_file'))
2176 self.assertEqual(stat.S_IMODE(st.st_mode), 0o750)
2177
Vajrasky Kokec1f5df2017-03-29 02:32:35 +07002178 @support.skip_unless_symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +01002179 def test_resolve_loop(self):
Anthony Shaw83da9262019-01-07 07:31:29 +11002180 # Loops with relative symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002181 os.symlink('linkX/inside', join('linkX'))
2182 self._check_symlink_loop(BASE, 'linkX')
2183 os.symlink('linkY', join('linkY'))
2184 self._check_symlink_loop(BASE, 'linkY')
2185 os.symlink('linkZ/../linkZ', join('linkZ'))
2186 self._check_symlink_loop(BASE, 'linkZ')
Steve Dower98eb3602016-11-09 12:58:17 -08002187 # Non-strict
2188 self._check_symlink_loop(BASE, 'linkZ', 'foo', strict=False)
Anthony Shaw83da9262019-01-07 07:31:29 +11002189 # Loops with absolute symlinks.
Antoine Pitrou31119e42013-11-22 17:38:12 +01002190 os.symlink(join('linkU/inside'), join('linkU'))
2191 self._check_symlink_loop(BASE, 'linkU')
2192 os.symlink(join('linkV'), join('linkV'))
2193 self._check_symlink_loop(BASE, 'linkV')
2194 os.symlink(join('linkW/../linkW'), join('linkW'))
2195 self._check_symlink_loop(BASE, 'linkW')
Steve Dower98eb3602016-11-09 12:58:17 -08002196 # Non-strict
2197 self._check_symlink_loop(BASE, 'linkW', 'foo', strict=False)
Antoine Pitrou31119e42013-11-22 17:38:12 +01002198
2199 def test_glob(self):
2200 P = self.cls
2201 p = P(BASE)
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002202 given = set(p.glob("FILEa"))
2203 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2204 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002205 self.assertEqual(set(p.glob("FILEa*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002206
2207 def test_rglob(self):
2208 P = self.cls
2209 p = P(BASE, "dirC")
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002210 given = set(p.rglob("FILEd"))
2211 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2212 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002213 self.assertEqual(set(p.rglob("FILEd*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002214
Xavier de Gayefb24eea2016-12-13 09:11:38 +01002215 @unittest.skipUnless(hasattr(pwd, 'getpwall'),
2216 'pwd module does not expose getpwall()')
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002217 def test_expanduser(self):
2218 P = self.cls
2219 support.import_module('pwd')
2220 import pwd
2221 pwdent = pwd.getpwuid(os.getuid())
2222 username = pwdent.pw_name
Serhiy Storchakaa3fd0b22016-05-03 21:17:03 +03002223 userhome = pwdent.pw_dir.rstrip('/') or '/'
Anthony Shaw83da9262019-01-07 07:31:29 +11002224 # Find arbitrary different user (if exists).
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002225 for pwdent in pwd.getpwall():
2226 othername = pwdent.pw_name
2227 otherhome = pwdent.pw_dir.rstrip('/')
Victor Stinnere9694392015-01-10 09:00:20 +01002228 if othername != username and otherhome:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002229 break
Anders Kaseorg5c0d4622018-05-14 10:00:37 -04002230 else:
2231 othername = username
2232 otherhome = userhome
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002233
2234 p1 = P('~/Documents')
2235 p2 = P('~' + username + '/Documents')
2236 p3 = P('~' + othername + '/Documents')
2237 p4 = P('../~' + username + '/Documents')
2238 p5 = P('/~' + username + '/Documents')
2239 p6 = P('')
2240 p7 = P('~fakeuser/Documents')
2241
2242 with support.EnvironmentVarGuard() as env:
2243 env.pop('HOME', None)
2244
2245 self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
2246 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2247 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2248 self.assertEqual(p4.expanduser(), p4)
2249 self.assertEqual(p5.expanduser(), p5)
2250 self.assertEqual(p6.expanduser(), p6)
2251 self.assertRaises(RuntimeError, p7.expanduser)
2252
2253 env['HOME'] = '/tmp'
2254 self.assertEqual(p1.expanduser(), P('/tmp/Documents'))
2255 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2256 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2257 self.assertEqual(p4.expanduser(), p4)
2258 self.assertEqual(p5.expanduser(), p5)
2259 self.assertEqual(p6.expanduser(), p6)
2260 self.assertRaises(RuntimeError, p7.expanduser)
2261
Przemysław Spodymek216b7452018-08-27 23:33:45 +02002262 @unittest.skipIf(sys.platform != "darwin",
2263 "Bad file descriptor in /dev/fd affects only macOS")
2264 def test_handling_bad_descriptor(self):
2265 try:
2266 file_descriptors = list(pathlib.Path('/dev/fd').rglob("*"))[3:]
2267 if not file_descriptors:
2268 self.skipTest("no file descriptors - issue was not reproduced")
2269 # Checking all file descriptors because there is no guarantee
2270 # which one will fail.
2271 for f in file_descriptors:
2272 f.exists()
2273 f.is_dir()
2274 f.is_file()
2275 f.is_symlink()
2276 f.is_block_device()
2277 f.is_char_device()
2278 f.is_fifo()
2279 f.is_socket()
2280 except OSError as e:
2281 if e.errno == errno.EBADF:
2282 self.fail("Bad file descriptor not handled.")
2283 raise
2284
Antoine Pitrou31119e42013-11-22 17:38:12 +01002285
2286@only_nt
2287class WindowsPathTest(_BasePathTest, unittest.TestCase):
2288 cls = pathlib.WindowsPath
2289
2290 def test_glob(self):
2291 P = self.cls
2292 p = P(BASE)
2293 self.assertEqual(set(p.glob("FILEa")), { P(BASE, "fileA") })
2294
2295 def test_rglob(self):
2296 P = self.cls
2297 p = P(BASE, "dirC")
2298 self.assertEqual(set(p.rglob("FILEd")), { P(BASE, "dirC/dirD/fileD") })
2299
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002300 def test_expanduser(self):
2301 P = self.cls
2302 with support.EnvironmentVarGuard() as env:
2303 env.pop('HOME', None)
2304 env.pop('USERPROFILE', None)
2305 env.pop('HOMEPATH', None)
2306 env.pop('HOMEDRIVE', None)
2307 env['USERNAME'] = 'alice'
2308
2309 # test that the path returns unchanged
2310 p1 = P('~/My Documents')
2311 p2 = P('~alice/My Documents')
2312 p3 = P('~bob/My Documents')
2313 p4 = P('/~/My Documents')
2314 p5 = P('d:~/My Documents')
2315 p6 = P('')
2316 self.assertRaises(RuntimeError, p1.expanduser)
2317 self.assertRaises(RuntimeError, p2.expanduser)
2318 self.assertRaises(RuntimeError, p3.expanduser)
2319 self.assertEqual(p4.expanduser(), p4)
2320 self.assertEqual(p5.expanduser(), p5)
2321 self.assertEqual(p6.expanduser(), p6)
2322
2323 def check():
2324 env.pop('USERNAME', None)
2325 self.assertEqual(p1.expanduser(),
2326 P('C:/Users/alice/My Documents'))
2327 self.assertRaises(KeyError, p2.expanduser)
2328 env['USERNAME'] = 'alice'
2329 self.assertEqual(p2.expanduser(),
2330 P('C:/Users/alice/My Documents'))
2331 self.assertEqual(p3.expanduser(),
2332 P('C:/Users/bob/My Documents'))
2333 self.assertEqual(p4.expanduser(), p4)
2334 self.assertEqual(p5.expanduser(), p5)
2335 self.assertEqual(p6.expanduser(), p6)
2336
Anthony Shaw83da9262019-01-07 07:31:29 +11002337 # Test the first lookup key in the env vars.
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002338 env['HOME'] = 'C:\\Users\\alice'
2339 check()
2340
Anthony Shaw83da9262019-01-07 07:31:29 +11002341 # Test that HOMEPATH is available instead.
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002342 env.pop('HOME', None)
2343 env['HOMEPATH'] = 'C:\\Users\\alice'
2344 check()
2345
2346 env['HOMEDRIVE'] = 'C:\\'
2347 env['HOMEPATH'] = 'Users\\alice'
2348 check()
2349
2350 env.pop('HOMEDRIVE', None)
2351 env.pop('HOMEPATH', None)
2352 env['USERPROFILE'] = 'C:\\Users\\alice'
2353 check()
2354
Antoine Pitrou31119e42013-11-22 17:38:12 +01002355
Miss Islington (bot)4adcaf82019-08-28 22:05:59 -07002356class CompatiblePathTest(unittest.TestCase):
2357 """
2358 Test that a type can be made compatible with PurePath
2359 derivatives by implementing division operator overloads.
2360 """
2361
2362 class CompatPath:
2363 """
2364 Minimum viable class to test PurePath compatibility.
2365 Simply uses the division operator to join a given
2366 string and the string value of another object with
2367 a forward slash.
2368 """
2369 def __init__(self, string):
2370 self.string = string
2371
2372 def __truediv__(self, other):
2373 return type(self)(f"{self.string}/{other}")
2374
2375 def __rtruediv__(self, other):
2376 return type(self)(f"{other}/{self.string}")
2377
2378 def test_truediv(self):
2379 result = pathlib.PurePath("test") / self.CompatPath("right")
2380 self.assertIsInstance(result, self.CompatPath)
2381 self.assertEqual(result.string, "test/right")
2382
2383 with self.assertRaises(TypeError):
2384 # Verify improper operations still raise a TypeError
2385 pathlib.PurePath("test") / 10
2386
2387 def test_rtruediv(self):
2388 result = self.CompatPath("left") / pathlib.PurePath("test")
2389 self.assertIsInstance(result, self.CompatPath)
2390 self.assertEqual(result.string, "left/test")
2391
2392 with self.assertRaises(TypeError):
2393 # Verify improper operations still raise a TypeError
2394 10 / pathlib.PurePath("test")
2395
2396
Antoine Pitrou31119e42013-11-22 17:38:12 +01002397if __name__ == "__main__":
2398 unittest.main()