blob: c14ddd033564ab9e41c89d2e9f73e38bda08fb21 [file] [log] [blame]
Antoine Pitrou31119e42013-11-22 17:38:12 +01001import fnmatch
2import functools
3import io
4import ntpath
5import os
6import posixpath
7import re
8import sys
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03009from collections.abc import Sequence
Antoine Pitrou2b2852b2014-10-30 23:14:03 +010010from errno import EINVAL, ENOENT, ENOTDIR
Antoine Pitrou31119e42013-11-22 17:38:12 +010011from operator import attrgetter
12from stat import S_ISDIR, S_ISLNK, S_ISREG, S_ISSOCK, S_ISBLK, S_ISCHR, S_ISFIFO
Antoine Pitrou069a5e12013-12-03 09:41:35 +010013from urllib.parse import quote_from_bytes as urlquote_from_bytes
Antoine Pitrou31119e42013-11-22 17:38:12 +010014
15
16supports_symlinks = True
Antoine Pitroudb118f52014-11-19 00:32:08 +010017if os.name == 'nt':
Antoine Pitrou31119e42013-11-22 17:38:12 +010018 import nt
Antoine Pitrou31119e42013-11-22 17:38:12 +010019 if sys.getwindowsversion()[:2] >= (6, 0):
20 from nt import _getfinalpathname
21 else:
22 supports_symlinks = False
23 _getfinalpathname = None
Antoine Pitroudb118f52014-11-19 00:32:08 +010024else:
25 nt = None
Antoine Pitrou31119e42013-11-22 17:38:12 +010026
27
28__all__ = [
29 "PurePath", "PurePosixPath", "PureWindowsPath",
30 "Path", "PosixPath", "WindowsPath",
31 ]
32
33#
34# Internals
35#
36
37def _is_wildcard_pattern(pat):
38 # Whether this pattern needs actual matching using fnmatch, or can
39 # be looked up directly as a file.
40 return "*" in pat or "?" in pat or "[" in pat
41
42
43class _Flavour(object):
44 """A flavour implements a particular (platform-specific) set of path
45 semantics."""
46
47 def __init__(self):
48 self.join = self.sep.join
49
50 def parse_parts(self, parts):
51 parsed = []
52 sep = self.sep
53 altsep = self.altsep
54 drv = root = ''
55 it = reversed(parts)
56 for part in it:
57 if not part:
58 continue
59 if altsep:
60 part = part.replace(altsep, sep)
61 drv, root, rel = self.splitroot(part)
62 if sep in rel:
63 for x in reversed(rel.split(sep)):
64 if x and x != '.':
65 parsed.append(sys.intern(x))
66 else:
67 if rel and rel != '.':
68 parsed.append(sys.intern(rel))
69 if drv or root:
70 if not drv:
71 # If no drive is present, try to find one in the previous
72 # parts. This makes the result of parsing e.g.
73 # ("C:", "/", "a") reasonably intuitive.
74 for part in it:
Antoine Pitrou57fffd62015-02-15 18:03:59 +010075 if not part:
76 continue
77 if altsep:
78 part = part.replace(altsep, sep)
Antoine Pitrou31119e42013-11-22 17:38:12 +010079 drv = self.splitroot(part)[0]
80 if drv:
81 break
82 break
83 if drv or root:
84 parsed.append(drv + root)
85 parsed.reverse()
86 return drv, root, parsed
87
88 def join_parsed_parts(self, drv, root, parts, drv2, root2, parts2):
89 """
90 Join the two paths represented by the respective
91 (drive, root, parts) tuples. Return a new (drive, root, parts) tuple.
92 """
93 if root2:
Serhiy Storchakaa9939022013-12-06 17:14:12 +020094 if not drv2 and drv:
95 return drv, root2, [drv + root2] + parts2[1:]
96 elif drv2:
97 if drv2 == drv or self.casefold(drv2) == self.casefold(drv):
98 # Same drive => second path is relative to the first
99 return drv, root, parts + parts2[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100100 else:
Serhiy Storchakaa9939022013-12-06 17:14:12 +0200101 # Second path is non-anchored (common case)
102 return drv, root, parts + parts2
103 return drv2, root2, parts2
Antoine Pitrou31119e42013-11-22 17:38:12 +0100104
105
106class _WindowsFlavour(_Flavour):
107 # Reference for Windows paths can be found at
108 # http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
109
110 sep = '\\'
111 altsep = '/'
112 has_drv = True
113 pathmod = ntpath
114
Antoine Pitroudb118f52014-11-19 00:32:08 +0100115 is_supported = (os.name == 'nt')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100116
Jon Dufresne39726282017-05-18 07:35:54 -0700117 drive_letters = set('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100118 ext_namespace_prefix = '\\\\?\\'
119
120 reserved_names = (
121 {'CON', 'PRN', 'AUX', 'NUL'} |
122 {'COM%d' % i for i in range(1, 10)} |
123 {'LPT%d' % i for i in range(1, 10)}
124 )
125
126 # Interesting findings about extended paths:
127 # - '\\?\c:\a', '//?/c:\a' and '//?/c:/a' are all supported
128 # but '\\?\c:/a' is not
129 # - extended paths are always absolute; "relative" extended paths will
130 # fail.
131
132 def splitroot(self, part, sep=sep):
133 first = part[0:1]
134 second = part[1:2]
135 if (second == sep and first == sep):
136 # XXX extended paths should also disable the collapsing of "."
137 # components (according to MSDN docs).
138 prefix, part = self._split_extended_path(part)
139 first = part[0:1]
140 second = part[1:2]
141 else:
142 prefix = ''
143 third = part[2:3]
144 if (second == sep and first == sep and third != sep):
145 # is a UNC path:
146 # vvvvvvvvvvvvvvvvvvvvv root
147 # \\machine\mountpoint\directory\etc\...
148 # directory ^^^^^^^^^^^^^^
149 index = part.find(sep, 2)
150 if index != -1:
151 index2 = part.find(sep, index + 1)
152 # a UNC path can't have two slashes in a row
153 # (after the initial two)
154 if index2 != index + 1:
155 if index2 == -1:
156 index2 = len(part)
157 if prefix:
158 return prefix + part[1:index2], sep, part[index2+1:]
159 else:
160 return part[:index2], sep, part[index2+1:]
161 drv = root = ''
162 if second == ':' and first in self.drive_letters:
163 drv = part[:2]
164 part = part[2:]
165 first = third
166 if first == sep:
167 root = first
168 part = part.lstrip(sep)
169 return prefix + drv, root, part
170
171 def casefold(self, s):
172 return s.lower()
173
174 def casefold_parts(self, parts):
175 return [p.lower() for p in parts]
176
Steve Dower98eb3602016-11-09 12:58:17 -0800177 def resolve(self, path, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100178 s = str(path)
179 if not s:
180 return os.getcwd()
Steve Dower98eb3602016-11-09 12:58:17 -0800181 previous_s = None
Antoine Pitrou31119e42013-11-22 17:38:12 +0100182 if _getfinalpathname is not None:
Steve Dower98eb3602016-11-09 12:58:17 -0800183 if strict:
184 return self._ext_to_normal(_getfinalpathname(s))
185 else:
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200186 tail_parts = [] # End of the path after the first one not found
Steve Dower98eb3602016-11-09 12:58:17 -0800187 while True:
188 try:
189 s = self._ext_to_normal(_getfinalpathname(s))
190 except FileNotFoundError:
191 previous_s = s
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200192 s, tail = os.path.split(s)
193 tail_parts.append(tail)
Steve Dower4b1e98b2016-12-28 16:02:59 -0800194 if previous_s == s:
195 return path
Steve Dower98eb3602016-11-09 12:58:17 -0800196 else:
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200197 return os.path.join(s, *reversed(tail_parts))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100198 # Means fallback on absolute
199 return None
200
201 def _split_extended_path(self, s, ext_prefix=ext_namespace_prefix):
202 prefix = ''
203 if s.startswith(ext_prefix):
204 prefix = s[:4]
205 s = s[4:]
206 if s.startswith('UNC\\'):
207 prefix += s[:3]
208 s = '\\' + s[3:]
209 return prefix, s
210
211 def _ext_to_normal(self, s):
212 # Turn back an extended path into a normal DOS-like path
213 return self._split_extended_path(s)[1]
214
215 def is_reserved(self, parts):
216 # NOTE: the rules for reserved names seem somewhat complicated
217 # (e.g. r"..\NUL" is reserved but not r"foo\NUL").
218 # We err on the side of caution and return True for paths which are
219 # not considered reserved by Windows.
220 if not parts:
221 return False
222 if parts[0].startswith('\\\\'):
223 # UNC paths are never reserved
224 return False
225 return parts[-1].partition('.')[0].upper() in self.reserved_names
226
227 def make_uri(self, path):
228 # Under Windows, file URIs use the UTF-8 encoding.
229 drive = path.drive
230 if len(drive) == 2 and drive[1] == ':':
231 # It's a path on a local drive => 'file:///c:/a/b'
232 rest = path.as_posix()[2:].lstrip('/')
233 return 'file:///%s/%s' % (
234 drive, urlquote_from_bytes(rest.encode('utf-8')))
235 else:
236 # It's a path on a network drive => 'file://host/share/a/b'
237 return 'file:' + urlquote_from_bytes(path.as_posix().encode('utf-8'))
238
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100239 def gethomedir(self, username):
240 if 'HOME' in os.environ:
241 userhome = os.environ['HOME']
242 elif 'USERPROFILE' in os.environ:
243 userhome = os.environ['USERPROFILE']
244 elif 'HOMEPATH' in os.environ:
Antoine Pitrou5d4e27e2014-12-30 22:09:42 +0100245 try:
246 drv = os.environ['HOMEDRIVE']
247 except KeyError:
248 drv = ''
249 userhome = drv + os.environ['HOMEPATH']
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100250 else:
251 raise RuntimeError("Can't determine home directory")
252
253 if username:
254 # Try to guess user home directory. By default all users
255 # directories are located in the same place and are named by
256 # corresponding usernames. If current user home directory points
257 # to nonstandard place, this guess is likely wrong.
258 if os.environ['USERNAME'] != username:
259 drv, root, parts = self.parse_parts((userhome,))
260 if parts[-1] != os.environ['USERNAME']:
261 raise RuntimeError("Can't determine home directory "
262 "for %r" % username)
263 parts[-1] = username
264 if drv or root:
265 userhome = drv + root + self.join(parts[1:])
266 else:
267 userhome = self.join(parts)
268 return userhome
Antoine Pitrou31119e42013-11-22 17:38:12 +0100269
270class _PosixFlavour(_Flavour):
271 sep = '/'
272 altsep = ''
273 has_drv = False
274 pathmod = posixpath
275
276 is_supported = (os.name != 'nt')
277
278 def splitroot(self, part, sep=sep):
279 if part and part[0] == sep:
280 stripped_part = part.lstrip(sep)
281 # According to POSIX path resolution:
282 # http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11
283 # "A pathname that begins with two successive slashes may be
284 # interpreted in an implementation-defined manner, although more
285 # than two leading slashes shall be treated as a single slash".
286 if len(part) - len(stripped_part) == 2:
287 return '', sep * 2, stripped_part
288 else:
289 return '', sep, stripped_part
290 else:
291 return '', '', part
292
293 def casefold(self, s):
294 return s
295
296 def casefold_parts(self, parts):
297 return parts
298
Steve Dower98eb3602016-11-09 12:58:17 -0800299 def resolve(self, path, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100300 sep = self.sep
Antoine Pitrou31119e42013-11-22 17:38:12 +0100301 accessor = path._accessor
Antoine Pitrouc274fd22013-12-16 19:57:41 +0100302 seen = {}
303 def _resolve(path, rest):
304 if rest.startswith(sep):
305 path = ''
306
307 for name in rest.split(sep):
308 if not name or name == '.':
309 # current dir
310 continue
311 if name == '..':
312 # parent dir
313 path, _, _ = path.rpartition(sep)
314 continue
315 newpath = path + sep + name
316 if newpath in seen:
317 # Already seen this path
318 path = seen[newpath]
319 if path is not None:
320 # use cached value
321 continue
322 # The symlink is not resolved, so we must have a symlink loop.
323 raise RuntimeError("Symlink loop from %r" % newpath)
324 # Resolve the symbolic link
325 try:
326 target = accessor.readlink(newpath)
327 except OSError as e:
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200328 if e.errno != EINVAL and strict:
329 raise
330 # Not a symlink, or non-strict mode. We just leave the path
331 # untouched.
Antoine Pitrouc274fd22013-12-16 19:57:41 +0100332 path = newpath
333 else:
334 seen[newpath] = None # not resolved symlink
335 path = _resolve(path, target)
336 seen[newpath] = path # resolved symlink
337
338 return path
339 # NOTE: according to POSIX, getcwd() cannot contain path components
340 # which are symlinks.
341 base = '' if path.is_absolute() else os.getcwd()
342 return _resolve(base, str(path)) or sep
Antoine Pitrou31119e42013-11-22 17:38:12 +0100343
344 def is_reserved(self, parts):
345 return False
346
347 def make_uri(self, path):
348 # We represent the path using the local filesystem encoding,
349 # for portability to other applications.
350 bpath = bytes(path)
351 return 'file://' + urlquote_from_bytes(bpath)
352
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100353 def gethomedir(self, username):
354 if not username:
355 try:
356 return os.environ['HOME']
357 except KeyError:
358 import pwd
359 return pwd.getpwuid(os.getuid()).pw_dir
360 else:
361 import pwd
362 try:
363 return pwd.getpwnam(username).pw_dir
364 except KeyError:
365 raise RuntimeError("Can't determine home directory "
366 "for %r" % username)
367
Antoine Pitrou31119e42013-11-22 17:38:12 +0100368
369_windows_flavour = _WindowsFlavour()
370_posix_flavour = _PosixFlavour()
371
372
373class _Accessor:
374 """An accessor implements a particular (system-specific or not) way of
375 accessing paths on the filesystem."""
376
377
378class _NormalAccessor(_Accessor):
379
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200380 stat = os.stat
Antoine Pitrou31119e42013-11-22 17:38:12 +0100381
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200382 lstat = os.lstat
Antoine Pitrou31119e42013-11-22 17:38:12 +0100383
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200384 open = os.open
Antoine Pitrou31119e42013-11-22 17:38:12 +0100385
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200386 listdir = os.listdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100387
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200388 scandir = os.scandir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100389
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200390 chmod = os.chmod
Antoine Pitrou31119e42013-11-22 17:38:12 +0100391
392 if hasattr(os, "lchmod"):
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200393 lchmod = os.lchmod
Antoine Pitrou31119e42013-11-22 17:38:12 +0100394 else:
395 def lchmod(self, pathobj, mode):
396 raise NotImplementedError("lchmod() not available on this system")
397
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200398 mkdir = os.mkdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100399
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200400 unlink = os.unlink
Antoine Pitrou31119e42013-11-22 17:38:12 +0100401
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200402 rmdir = os.rmdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100403
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200404 rename = os.rename
Antoine Pitrou31119e42013-11-22 17:38:12 +0100405
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200406 replace = os.replace
Antoine Pitrou31119e42013-11-22 17:38:12 +0100407
408 if nt:
409 if supports_symlinks:
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200410 symlink = os.symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +0100411 else:
412 def symlink(a, b, target_is_directory):
413 raise NotImplementedError("symlink() not available on this system")
414 else:
415 # Under POSIX, os.symlink() takes two args
416 @staticmethod
417 def symlink(a, b, target_is_directory):
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200418 return os.symlink(a, b)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100419
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200420 utime = os.utime
Antoine Pitrou31119e42013-11-22 17:38:12 +0100421
422 # Helper for resolve()
423 def readlink(self, path):
424 return os.readlink(path)
425
426
427_normal_accessor = _NormalAccessor()
428
429
430#
431# Globbing helpers
432#
433
Antoine Pitrou31119e42013-11-22 17:38:12 +0100434def _make_selector(pattern_parts):
435 pat = pattern_parts[0]
436 child_parts = pattern_parts[1:]
437 if pat == '**':
438 cls = _RecursiveWildcardSelector
439 elif '**' in pat:
440 raise ValueError("Invalid pattern: '**' can only be an entire path component")
441 elif _is_wildcard_pattern(pat):
442 cls = _WildcardSelector
443 else:
444 cls = _PreciseSelector
445 return cls(pat, child_parts)
446
447if hasattr(functools, "lru_cache"):
448 _make_selector = functools.lru_cache()(_make_selector)
449
450
451class _Selector:
452 """A selector matches a specific glob pattern part against the children
453 of a given path."""
454
455 def __init__(self, child_parts):
456 self.child_parts = child_parts
457 if child_parts:
458 self.successor = _make_selector(child_parts)
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300459 self.dironly = True
Antoine Pitrou31119e42013-11-22 17:38:12 +0100460 else:
461 self.successor = _TerminatingSelector()
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300462 self.dironly = False
Antoine Pitrou31119e42013-11-22 17:38:12 +0100463
464 def select_from(self, parent_path):
465 """Iterate over all child paths of `parent_path` matched by this
466 selector. This can contain parent_path itself."""
467 path_cls = type(parent_path)
468 is_dir = path_cls.is_dir
469 exists = path_cls.exists
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300470 scandir = parent_path._accessor.scandir
471 if not is_dir(parent_path):
472 return iter([])
473 return self._select_from(parent_path, is_dir, exists, scandir)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100474
475
476class _TerminatingSelector:
477
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300478 def _select_from(self, parent_path, is_dir, exists, scandir):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100479 yield parent_path
480
481
482class _PreciseSelector(_Selector):
483
484 def __init__(self, name, child_parts):
485 self.name = name
486 _Selector.__init__(self, child_parts)
487
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300488 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800489 try:
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800490 path = parent_path._make_child_relpath(self.name)
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300491 if (is_dir if self.dironly else exists)(path):
492 for p in self.successor._select_from(path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800493 yield p
494 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100495 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100496
497
498class _WildcardSelector(_Selector):
499
500 def __init__(self, pat, child_parts):
501 self.pat = re.compile(fnmatch.translate(pat))
502 _Selector.__init__(self, child_parts)
503
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300504 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800505 try:
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800506 cf = parent_path._flavour.casefold
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300507 entries = list(scandir(parent_path))
508 for entry in entries:
509 if not self.dironly or entry.is_dir():
510 name = entry.name
511 casefolded = cf(name)
512 if self.pat.match(casefolded):
513 path = parent_path._make_child_relpath(name)
514 for p in self.successor._select_from(path, is_dir, exists, scandir):
515 yield p
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800516 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100517 return
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800518
Antoine Pitrou31119e42013-11-22 17:38:12 +0100519
520
521class _RecursiveWildcardSelector(_Selector):
522
523 def __init__(self, pat, child_parts):
524 _Selector.__init__(self, child_parts)
525
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300526 def _iterate_directories(self, parent_path, is_dir, scandir):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100527 yield parent_path
Guido van Rossumbc9fdda2016-01-07 10:56:36 -0800528 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300529 entries = list(scandir(parent_path))
530 for entry in entries:
531 if entry.is_dir() and not entry.is_symlink():
532 path = parent_path._make_child_relpath(entry.name)
533 for p in self._iterate_directories(path, is_dir, scandir):
Guido van Rossumbc9fdda2016-01-07 10:56:36 -0800534 yield p
535 except PermissionError:
536 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100537
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300538 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800539 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300540 yielded = set()
541 try:
542 successor_select = self.successor._select_from
543 for starting_point in self._iterate_directories(parent_path, is_dir, scandir):
544 for p in successor_select(starting_point, is_dir, exists, scandir):
545 if p not in yielded:
546 yield p
547 yielded.add(p)
548 finally:
549 yielded.clear()
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800550 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100551 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100552
553
554#
555# Public API
556#
557
558class _PathParents(Sequence):
559 """This object provides sequence-like access to the logical ancestors
560 of a path. Don't try to construct it yourself."""
561 __slots__ = ('_pathcls', '_drv', '_root', '_parts')
562
563 def __init__(self, path):
564 # We don't store the instance to avoid reference cycles
565 self._pathcls = type(path)
566 self._drv = path._drv
567 self._root = path._root
568 self._parts = path._parts
569
570 def __len__(self):
571 if self._drv or self._root:
572 return len(self._parts) - 1
573 else:
574 return len(self._parts)
575
576 def __getitem__(self, idx):
577 if idx < 0 or idx >= len(self):
578 raise IndexError(idx)
579 return self._pathcls._from_parsed_parts(self._drv, self._root,
580 self._parts[:-idx - 1])
581
582 def __repr__(self):
583 return "<{}.parents>".format(self._pathcls.__name__)
584
585
586class PurePath(object):
587 """PurePath represents a filesystem path and offers operations which
588 don't imply any actual filesystem I/O. Depending on your system,
589 instantiating a PurePath will return either a PurePosixPath or a
590 PureWindowsPath object. You can also instantiate either of these classes
591 directly, regardless of your system.
592 """
593 __slots__ = (
594 '_drv', '_root', '_parts',
595 '_str', '_hash', '_pparts', '_cached_cparts',
596 )
597
598 def __new__(cls, *args):
599 """Construct a PurePath from one or several strings and or existing
600 PurePath objects. The strings and path objects are combined so as
601 to yield a canonicalized path, which is incorporated into the
602 new PurePath object.
603 """
604 if cls is PurePath:
605 cls = PureWindowsPath if os.name == 'nt' else PurePosixPath
606 return cls._from_parts(args)
607
608 def __reduce__(self):
609 # Using the parts tuple helps share interned path parts
610 # when pickling related paths.
611 return (self.__class__, tuple(self._parts))
612
613 @classmethod
614 def _parse_args(cls, args):
615 # This is useful when you don't want to create an instance, just
616 # canonicalize some constructor arguments.
617 parts = []
618 for a in args:
619 if isinstance(a, PurePath):
620 parts += a._parts
Antoine Pitrou31119e42013-11-22 17:38:12 +0100621 else:
Brett Cannon568be632016-06-10 12:20:49 -0700622 a = os.fspath(a)
623 if isinstance(a, str):
624 # Force-cast str subclasses to str (issue #21127)
625 parts.append(str(a))
626 else:
627 raise TypeError(
628 "argument should be a str object or an os.PathLike "
629 "object returning str, not %r"
630 % type(a))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100631 return cls._flavour.parse_parts(parts)
632
633 @classmethod
634 def _from_parts(cls, args, init=True):
635 # We need to call _parse_args on the instance, so as to get the
636 # right flavour.
637 self = object.__new__(cls)
638 drv, root, parts = self._parse_args(args)
639 self._drv = drv
640 self._root = root
641 self._parts = parts
642 if init:
643 self._init()
644 return self
645
646 @classmethod
647 def _from_parsed_parts(cls, drv, root, parts, init=True):
648 self = object.__new__(cls)
649 self._drv = drv
650 self._root = root
651 self._parts = parts
652 if init:
653 self._init()
654 return self
655
656 @classmethod
657 def _format_parsed_parts(cls, drv, root, parts):
658 if drv or root:
659 return drv + root + cls._flavour.join(parts[1:])
660 else:
661 return cls._flavour.join(parts)
662
663 def _init(self):
Martin Pantere26da7c2016-06-02 10:07:09 +0000664 # Overridden in concrete Path
Antoine Pitrou31119e42013-11-22 17:38:12 +0100665 pass
666
667 def _make_child(self, args):
668 drv, root, parts = self._parse_args(args)
669 drv, root, parts = self._flavour.join_parsed_parts(
670 self._drv, self._root, self._parts, drv, root, parts)
671 return self._from_parsed_parts(drv, root, parts)
672
673 def __str__(self):
674 """Return the string representation of the path, suitable for
675 passing to system calls."""
676 try:
677 return self._str
678 except AttributeError:
679 self._str = self._format_parsed_parts(self._drv, self._root,
680 self._parts) or '.'
681 return self._str
682
Brett Cannon568be632016-06-10 12:20:49 -0700683 def __fspath__(self):
684 return str(self)
685
Antoine Pitrou31119e42013-11-22 17:38:12 +0100686 def as_posix(self):
687 """Return the string representation of the path with forward (/)
688 slashes."""
689 f = self._flavour
690 return str(self).replace(f.sep, '/')
691
692 def __bytes__(self):
693 """Return the bytes representation of the path. This is only
694 recommended to use under Unix."""
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200695 return os.fsencode(self)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100696
697 def __repr__(self):
698 return "{}({!r})".format(self.__class__.__name__, self.as_posix())
699
700 def as_uri(self):
701 """Return the path as a 'file' URI."""
702 if not self.is_absolute():
703 raise ValueError("relative path can't be expressed as a file URI")
704 return self._flavour.make_uri(self)
705
706 @property
707 def _cparts(self):
708 # Cached casefolded parts, for hashing and comparison
709 try:
710 return self._cached_cparts
711 except AttributeError:
712 self._cached_cparts = self._flavour.casefold_parts(self._parts)
713 return self._cached_cparts
714
715 def __eq__(self, other):
716 if not isinstance(other, PurePath):
717 return NotImplemented
718 return self._cparts == other._cparts and self._flavour is other._flavour
719
Antoine Pitrou31119e42013-11-22 17:38:12 +0100720 def __hash__(self):
721 try:
722 return self._hash
723 except AttributeError:
724 self._hash = hash(tuple(self._cparts))
725 return self._hash
726
727 def __lt__(self, other):
728 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
729 return NotImplemented
730 return self._cparts < other._cparts
731
732 def __le__(self, other):
733 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
734 return NotImplemented
735 return self._cparts <= other._cparts
736
737 def __gt__(self, other):
738 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
739 return NotImplemented
740 return self._cparts > other._cparts
741
742 def __ge__(self, other):
743 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
744 return NotImplemented
745 return self._cparts >= other._cparts
746
747 drive = property(attrgetter('_drv'),
748 doc="""The drive prefix (letter or UNC path), if any.""")
749
750 root = property(attrgetter('_root'),
751 doc="""The root of the path, if any.""")
752
753 @property
754 def anchor(self):
755 """The concatenation of the drive and root, or ''."""
756 anchor = self._drv + self._root
757 return anchor
758
759 @property
760 def name(self):
761 """The final path component, if any."""
762 parts = self._parts
763 if len(parts) == (1 if (self._drv or self._root) else 0):
764 return ''
765 return parts[-1]
766
767 @property
768 def suffix(self):
769 """The final component's last suffix, if any."""
770 name = self.name
771 i = name.rfind('.')
772 if 0 < i < len(name) - 1:
773 return name[i:]
774 else:
775 return ''
776
777 @property
778 def suffixes(self):
779 """A list of the final component's suffixes, if any."""
780 name = self.name
781 if name.endswith('.'):
782 return []
783 name = name.lstrip('.')
784 return ['.' + suffix for suffix in name.split('.')[1:]]
785
786 @property
787 def stem(self):
788 """The final path component, minus its last suffix."""
789 name = self.name
790 i = name.rfind('.')
791 if 0 < i < len(name) - 1:
792 return name[:i]
793 else:
794 return name
795
796 def with_name(self, name):
797 """Return a new path with the file name changed."""
798 if not self.name:
799 raise ValueError("%r has an empty name" % (self,))
Antoine Pitrou7084e732014-07-06 21:31:12 -0400800 drv, root, parts = self._flavour.parse_parts((name,))
801 if (not name or name[-1] in [self._flavour.sep, self._flavour.altsep]
802 or drv or root or len(parts) != 1):
803 raise ValueError("Invalid name %r" % (name))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100804 return self._from_parsed_parts(self._drv, self._root,
805 self._parts[:-1] + [name])
806
807 def with_suffix(self, suffix):
808 """Return a new path with the file suffix changed (or added, if none)."""
809 # XXX if suffix is None, should the current suffix be removed?
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400810 f = self._flavour
811 if f.sep in suffix or f.altsep and f.altsep in suffix:
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100812 raise ValueError("Invalid suffix %r" % (suffix))
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400813 if suffix and not suffix.startswith('.') or suffix == '.':
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100814 raise ValueError("Invalid suffix %r" % (suffix))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100815 name = self.name
816 if not name:
817 raise ValueError("%r has an empty name" % (self,))
818 old_suffix = self.suffix
819 if not old_suffix:
820 name = name + suffix
821 else:
822 name = name[:-len(old_suffix)] + suffix
823 return self._from_parsed_parts(self._drv, self._root,
824 self._parts[:-1] + [name])
825
826 def relative_to(self, *other):
827 """Return the relative path to another path identified by the passed
828 arguments. If the operation is not possible (because this is not
829 a subpath of the other path), raise ValueError.
830 """
831 # For the purpose of this method, drive and root are considered
832 # separate parts, i.e.:
833 # Path('c:/').relative_to('c:') gives Path('/')
834 # Path('c:/').relative_to('/') raise ValueError
835 if not other:
836 raise TypeError("need at least one argument")
837 parts = self._parts
838 drv = self._drv
839 root = self._root
Antoine Pitrou156b3612013-12-28 19:49:04 +0100840 if root:
841 abs_parts = [drv, root] + parts[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100842 else:
843 abs_parts = parts
844 to_drv, to_root, to_parts = self._parse_args(other)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100845 if to_root:
846 to_abs_parts = [to_drv, to_root] + to_parts[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100847 else:
848 to_abs_parts = to_parts
849 n = len(to_abs_parts)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100850 cf = self._flavour.casefold_parts
851 if (root or drv) if n == 0 else cf(abs_parts[:n]) != cf(to_abs_parts):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100852 formatted = self._format_parsed_parts(to_drv, to_root, to_parts)
853 raise ValueError("{!r} does not start with {!r}"
854 .format(str(self), str(formatted)))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100855 return self._from_parsed_parts('', root if n == 1 else '',
856 abs_parts[n:])
Antoine Pitrou31119e42013-11-22 17:38:12 +0100857
858 @property
859 def parts(self):
860 """An object providing sequence-like access to the
861 components in the filesystem path."""
862 # We cache the tuple to avoid building a new one each time .parts
863 # is accessed. XXX is this necessary?
864 try:
865 return self._pparts
866 except AttributeError:
867 self._pparts = tuple(self._parts)
868 return self._pparts
869
870 def joinpath(self, *args):
871 """Combine this path with one or several arguments, and return a
872 new path representing either a subpath (if all arguments are relative
873 paths) or a totally different path (if one of the arguments is
874 anchored).
875 """
876 return self._make_child(args)
877
878 def __truediv__(self, key):
879 return self._make_child((key,))
880
881 def __rtruediv__(self, key):
882 return self._from_parts([key] + self._parts)
883
884 @property
885 def parent(self):
886 """The logical parent of the path."""
887 drv = self._drv
888 root = self._root
889 parts = self._parts
890 if len(parts) == 1 and (drv or root):
891 return self
892 return self._from_parsed_parts(drv, root, parts[:-1])
893
894 @property
895 def parents(self):
896 """A sequence of this path's logical parents."""
897 return _PathParents(self)
898
899 def is_absolute(self):
900 """True if the path is absolute (has both a root and, if applicable,
901 a drive)."""
902 if not self._root:
903 return False
904 return not self._flavour.has_drv or bool(self._drv)
905
906 def is_reserved(self):
907 """Return True if the path contains one of the special names reserved
908 by the system, if any."""
909 return self._flavour.is_reserved(self._parts)
910
911 def match(self, path_pattern):
912 """
913 Return True if this path matches the given pattern.
914 """
915 cf = self._flavour.casefold
916 path_pattern = cf(path_pattern)
917 drv, root, pat_parts = self._flavour.parse_parts((path_pattern,))
918 if not pat_parts:
919 raise ValueError("empty pattern")
920 if drv and drv != cf(self._drv):
921 return False
922 if root and root != cf(self._root):
923 return False
924 parts = self._cparts
925 if drv or root:
926 if len(pat_parts) != len(parts):
927 return False
928 pat_parts = pat_parts[1:]
929 elif len(pat_parts) > len(parts):
930 return False
931 for part, pat in zip(reversed(parts), reversed(pat_parts)):
932 if not fnmatch.fnmatchcase(part, pat):
933 return False
934 return True
935
Brett Cannon568be632016-06-10 12:20:49 -0700936# Can't subclass os.PathLike from PurePath and keep the constructor
937# optimizations in PurePath._parse_args().
938os.PathLike.register(PurePath)
939
Antoine Pitrou31119e42013-11-22 17:38:12 +0100940
941class PurePosixPath(PurePath):
942 _flavour = _posix_flavour
943 __slots__ = ()
944
945
946class PureWindowsPath(PurePath):
947 _flavour = _windows_flavour
948 __slots__ = ()
949
950
951# Filesystem-accessing classes
952
953
954class Path(PurePath):
955 __slots__ = (
956 '_accessor',
957 '_closed',
958 )
959
960 def __new__(cls, *args, **kwargs):
961 if cls is Path:
962 cls = WindowsPath if os.name == 'nt' else PosixPath
963 self = cls._from_parts(args, init=False)
964 if not self._flavour.is_supported:
965 raise NotImplementedError("cannot instantiate %r on your system"
966 % (cls.__name__,))
967 self._init()
968 return self
969
970 def _init(self,
971 # Private non-constructor arguments
972 template=None,
973 ):
974 self._closed = False
975 if template is not None:
976 self._accessor = template._accessor
977 else:
978 self._accessor = _normal_accessor
979
980 def _make_child_relpath(self, part):
981 # This is an optimization used for dir walking. `part` must be
982 # a single part relative to this path.
983 parts = self._parts + [part]
984 return self._from_parsed_parts(self._drv, self._root, parts)
985
986 def __enter__(self):
987 if self._closed:
988 self._raise_closed()
989 return self
990
991 def __exit__(self, t, v, tb):
992 self._closed = True
993
994 def _raise_closed(self):
995 raise ValueError("I/O operation on closed path")
996
997 def _opener(self, name, flags, mode=0o666):
998 # A stub for the opener argument to built-in open()
999 return self._accessor.open(self, flags, mode)
1000
Antoine Pitrou4a60d422013-12-02 21:25:18 +01001001 def _raw_open(self, flags, mode=0o777):
1002 """
1003 Open the file pointed by this path and return a file descriptor,
1004 as os.open() does.
1005 """
1006 if self._closed:
1007 self._raise_closed()
1008 return self._accessor.open(self, flags, mode)
1009
Antoine Pitrou31119e42013-11-22 17:38:12 +01001010 # Public API
1011
1012 @classmethod
1013 def cwd(cls):
1014 """Return a new path pointing to the current working directory
1015 (as returned by os.getcwd()).
1016 """
1017 return cls(os.getcwd())
1018
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001019 @classmethod
1020 def home(cls):
1021 """Return a new path pointing to the user's home directory (as
1022 returned by os.path.expanduser('~')).
1023 """
1024 return cls(cls()._flavour.gethomedir(None))
1025
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001026 def samefile(self, other_path):
Berker Peksag05492b82015-10-22 03:34:16 +03001027 """Return whether other_path is the same or not as this file
Berker Peksag267597f2015-10-21 20:10:24 +03001028 (as returned by os.path.samefile()).
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001029 """
1030 st = self.stat()
1031 try:
1032 other_st = other_path.stat()
1033 except AttributeError:
1034 other_st = os.stat(other_path)
1035 return os.path.samestat(st, other_st)
1036
Antoine Pitrou31119e42013-11-22 17:38:12 +01001037 def iterdir(self):
1038 """Iterate over the files in this directory. Does not yield any
1039 result for the special paths '.' and '..'.
1040 """
1041 if self._closed:
1042 self._raise_closed()
1043 for name in self._accessor.listdir(self):
1044 if name in {'.', '..'}:
1045 # Yielding a path object for these makes little sense
1046 continue
1047 yield self._make_child_relpath(name)
1048 if self._closed:
1049 self._raise_closed()
1050
1051 def glob(self, pattern):
1052 """Iterate over this subtree and yield all existing files (of any
1053 kind, including directories) matching the given pattern.
1054 """
Berker Peksag4a208e42016-01-30 17:50:48 +02001055 if not pattern:
1056 raise ValueError("Unacceptable pattern: {!r}".format(pattern))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001057 pattern = self._flavour.casefold(pattern)
1058 drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
1059 if drv or root:
1060 raise NotImplementedError("Non-relative patterns are unsupported")
1061 selector = _make_selector(tuple(pattern_parts))
1062 for p in selector.select_from(self):
1063 yield p
1064
1065 def rglob(self, pattern):
1066 """Recursively yield all existing files (of any kind, including
1067 directories) matching the given pattern, anywhere in this subtree.
1068 """
1069 pattern = self._flavour.casefold(pattern)
1070 drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
1071 if drv or root:
1072 raise NotImplementedError("Non-relative patterns are unsupported")
1073 selector = _make_selector(("**",) + tuple(pattern_parts))
1074 for p in selector.select_from(self):
1075 yield p
1076
1077 def absolute(self):
1078 """Return an absolute version of this path. This function works
1079 even if the path doesn't point to anything.
1080
1081 No normalization is done, i.e. all '.' and '..' will be kept along.
1082 Use resolve() to get the canonical path to a file.
1083 """
1084 # XXX untested yet!
1085 if self._closed:
1086 self._raise_closed()
1087 if self.is_absolute():
1088 return self
1089 # FIXME this must defer to the specific flavour (and, under Windows,
1090 # use nt._getfullpathname())
1091 obj = self._from_parts([os.getcwd()] + self._parts, init=False)
1092 obj._init(template=self)
1093 return obj
1094
Steve Dower98eb3602016-11-09 12:58:17 -08001095 def resolve(self, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001096 """
1097 Make the path absolute, resolving all symlinks on the way and also
1098 normalizing it (for example turning slashes into backslashes under
1099 Windows).
1100 """
1101 if self._closed:
1102 self._raise_closed()
Steve Dower98eb3602016-11-09 12:58:17 -08001103 s = self._flavour.resolve(self, strict=strict)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001104 if s is None:
1105 # No symlink resolution => for consistency, raise an error if
1106 # the path doesn't exist or is forbidden
1107 self.stat()
1108 s = str(self.absolute())
1109 # Now we have no symlinks in the path, it's safe to normalize it.
1110 normed = self._flavour.pathmod.normpath(s)
1111 obj = self._from_parts((normed,), init=False)
1112 obj._init(template=self)
1113 return obj
1114
1115 def stat(self):
1116 """
1117 Return the result of the stat() system call on this path, like
1118 os.stat() does.
1119 """
1120 return self._accessor.stat(self)
1121
1122 def owner(self):
1123 """
1124 Return the login name of the file owner.
1125 """
1126 import pwd
1127 return pwd.getpwuid(self.stat().st_uid).pw_name
1128
1129 def group(self):
1130 """
1131 Return the group name of the file gid.
1132 """
1133 import grp
1134 return grp.getgrgid(self.stat().st_gid).gr_name
1135
Antoine Pitrou31119e42013-11-22 17:38:12 +01001136 def open(self, mode='r', buffering=-1, encoding=None,
1137 errors=None, newline=None):
1138 """
1139 Open the file pointed by this path and return a file object, as
1140 the built-in open() function does.
1141 """
1142 if self._closed:
1143 self._raise_closed()
Serhiy Storchaka62a99512017-03-25 13:42:11 +02001144 return io.open(self, mode, buffering, encoding, errors, newline,
Antoine Pitrou31119e42013-11-22 17:38:12 +01001145 opener=self._opener)
1146
Georg Brandlea683982014-10-01 19:12:33 +02001147 def read_bytes(self):
1148 """
1149 Open the file in bytes mode, read it, and close the file.
1150 """
1151 with self.open(mode='rb') as f:
1152 return f.read()
1153
1154 def read_text(self, encoding=None, errors=None):
1155 """
1156 Open the file in text mode, read it, and close the file.
1157 """
1158 with self.open(mode='r', encoding=encoding, errors=errors) as f:
1159 return f.read()
1160
1161 def write_bytes(self, data):
1162 """
1163 Open the file in bytes mode, write to it, and close the file.
1164 """
1165 # type-check for the buffer interface before truncating the file
1166 view = memoryview(data)
1167 with self.open(mode='wb') as f:
1168 return f.write(view)
1169
1170 def write_text(self, data, encoding=None, errors=None):
1171 """
1172 Open the file in text mode, write to it, and close the file.
1173 """
1174 if not isinstance(data, str):
1175 raise TypeError('data must be str, not %s' %
1176 data.__class__.__name__)
1177 with self.open(mode='w', encoding=encoding, errors=errors) as f:
1178 return f.write(data)
1179
Antoine Pitrou31119e42013-11-22 17:38:12 +01001180 def touch(self, mode=0o666, exist_ok=True):
1181 """
1182 Create this file with the given access mode, if it doesn't exist.
1183 """
1184 if self._closed:
1185 self._raise_closed()
1186 if exist_ok:
1187 # First try to bump modification time
1188 # Implementation note: GNU touch uses the UTIME_NOW option of
1189 # the utimensat() / futimens() functions.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001190 try:
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001191 self._accessor.utime(self, None)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001192 except OSError:
1193 # Avoid exception chaining
1194 pass
1195 else:
1196 return
1197 flags = os.O_CREAT | os.O_WRONLY
1198 if not exist_ok:
1199 flags |= os.O_EXCL
1200 fd = self._raw_open(flags, mode)
1201 os.close(fd)
1202
Barry Warsaw7c549c42014-08-05 11:28:12 -04001203 def mkdir(self, mode=0o777, parents=False, exist_ok=False):
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001204 """
1205 Create a new directory at this given path.
1206 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001207 if self._closed:
1208 self._raise_closed()
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001209 try:
1210 self._accessor.mkdir(self, mode)
1211 except FileNotFoundError:
1212 if not parents or self.parent == self:
1213 raise
Armin Rigo22a594a2017-04-13 20:08:15 +02001214 self.parent.mkdir(parents=True, exist_ok=True)
1215 self.mkdir(mode, parents=False, exist_ok=exist_ok)
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001216 except OSError:
1217 # Cannot rely on checking for EEXIST, since the operating system
1218 # could give priority to other errors like EACCES or EROFS
1219 if not exist_ok or not self.is_dir():
1220 raise
Antoine Pitrou31119e42013-11-22 17:38:12 +01001221
1222 def chmod(self, mode):
1223 """
1224 Change the permissions of the path, like os.chmod().
1225 """
1226 if self._closed:
1227 self._raise_closed()
1228 self._accessor.chmod(self, mode)
1229
1230 def lchmod(self, mode):
1231 """
1232 Like chmod(), except if the path points to a symlink, the symlink's
1233 permissions are changed, rather than its target's.
1234 """
1235 if self._closed:
1236 self._raise_closed()
1237 self._accessor.lchmod(self, mode)
1238
1239 def unlink(self):
1240 """
1241 Remove this file or link.
1242 If the path is a directory, use rmdir() instead.
1243 """
1244 if self._closed:
1245 self._raise_closed()
1246 self._accessor.unlink(self)
1247
1248 def rmdir(self):
1249 """
1250 Remove this directory. The directory must be empty.
1251 """
1252 if self._closed:
1253 self._raise_closed()
1254 self._accessor.rmdir(self)
1255
1256 def lstat(self):
1257 """
1258 Like stat(), except if the path points to a symlink, the symlink's
1259 status information is returned, rather than its target's.
1260 """
1261 if self._closed:
1262 self._raise_closed()
1263 return self._accessor.lstat(self)
1264
1265 def rename(self, target):
1266 """
1267 Rename this path to the given path.
1268 """
1269 if self._closed:
1270 self._raise_closed()
1271 self._accessor.rename(self, target)
1272
1273 def replace(self, target):
1274 """
1275 Rename this path to the given path, clobbering the existing
1276 destination if it exists.
1277 """
1278 if self._closed:
1279 self._raise_closed()
1280 self._accessor.replace(self, target)
1281
1282 def symlink_to(self, target, target_is_directory=False):
1283 """
1284 Make this path a symlink pointing to the given path.
1285 Note the order of arguments (self, target) is the reverse of os.symlink's.
1286 """
1287 if self._closed:
1288 self._raise_closed()
1289 self._accessor.symlink(target, self, target_is_directory)
1290
1291 # Convenience functions for querying the stat results
1292
1293 def exists(self):
1294 """
1295 Whether this path exists.
1296 """
1297 try:
1298 self.stat()
1299 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001300 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001301 raise
1302 return False
1303 return True
1304
1305 def is_dir(self):
1306 """
1307 Whether this path is a directory.
1308 """
1309 try:
1310 return S_ISDIR(self.stat().st_mode)
1311 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001312 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001313 raise
1314 # Path doesn't exist or is a broken symlink
1315 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1316 return False
1317
1318 def is_file(self):
1319 """
1320 Whether this path is a regular file (also True for symlinks pointing
1321 to regular files).
1322 """
1323 try:
1324 return S_ISREG(self.stat().st_mode)
1325 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001326 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001327 raise
1328 # Path doesn't exist or is a broken symlink
1329 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1330 return False
1331
Cooper Lees173ff4a2017-08-01 15:35:45 -07001332 def is_mount(self):
1333 """
1334 Check if this path is a POSIX mount point
1335 """
1336 # Need to exist and be a dir
1337 if not self.exists() or not self.is_dir():
1338 return False
1339
1340 parent = Path(self.parent)
1341 try:
1342 parent_dev = parent.stat().st_dev
1343 except OSError:
1344 return False
1345
1346 dev = self.stat().st_dev
1347 if dev != parent_dev:
1348 return True
1349 ino = self.stat().st_ino
1350 parent_ino = parent.stat().st_ino
1351 return ino == parent_ino
1352
Antoine Pitrou31119e42013-11-22 17:38:12 +01001353 def is_symlink(self):
1354 """
1355 Whether this path is a symbolic link.
1356 """
1357 try:
1358 return S_ISLNK(self.lstat().st_mode)
1359 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001360 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001361 raise
1362 # Path doesn't exist
1363 return False
1364
1365 def is_block_device(self):
1366 """
1367 Whether this path is a block device.
1368 """
1369 try:
1370 return S_ISBLK(self.stat().st_mode)
1371 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001372 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001373 raise
1374 # Path doesn't exist or is a broken symlink
1375 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1376 return False
1377
1378 def is_char_device(self):
1379 """
1380 Whether this path is a character device.
1381 """
1382 try:
1383 return S_ISCHR(self.stat().st_mode)
1384 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001385 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001386 raise
1387 # Path doesn't exist or is a broken symlink
1388 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1389 return False
1390
1391 def is_fifo(self):
1392 """
1393 Whether this path is a FIFO.
1394 """
1395 try:
1396 return S_ISFIFO(self.stat().st_mode)
1397 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001398 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001399 raise
1400 # Path doesn't exist or is a broken symlink
1401 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1402 return False
1403
1404 def is_socket(self):
1405 """
1406 Whether this path is a socket.
1407 """
1408 try:
1409 return S_ISSOCK(self.stat().st_mode)
1410 except OSError as e:
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001411 if e.errno not in (ENOENT, ENOTDIR):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001412 raise
1413 # Path doesn't exist or is a broken symlink
1414 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1415 return False
1416
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001417 def expanduser(self):
1418 """ Return a new path with expanded ~ and ~user constructs
1419 (as returned by os.path.expanduser)
1420 """
1421 if (not (self._drv or self._root) and
1422 self._parts and self._parts[0][:1] == '~'):
1423 homedir = self._flavour.gethomedir(self._parts[0][1:])
1424 return self._from_parts([homedir] + self._parts[1:])
1425
1426 return self
1427
Antoine Pitrou31119e42013-11-22 17:38:12 +01001428
1429class PosixPath(Path, PurePosixPath):
1430 __slots__ = ()
1431
1432class WindowsPath(Path, PureWindowsPath):
1433 __slots__ = ()
Berker Peksag04d42292016-03-11 23:07:27 +02001434
1435 def owner(self):
1436 raise NotImplementedError("Path.owner() is unsupported on this system")
1437
1438 def group(self):
1439 raise NotImplementedError("Path.group() is unsupported on this system")
Cooper Lees173ff4a2017-08-01 15:35:45 -07001440
1441 def is_mount(self):
1442 raise NotImplementedError("Path.is_mount() is unsupported on this system")