blob: 67b94e01545413280dc513dcdd7895cdb8cb0e1a [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 Storchaka81108372017-09-26 00:55:55 +03009from _collections_abc import Sequence
Jörg Stucked5c120f2019-05-21 19:44:40 +020010from errno import EINVAL, ENOENT, ENOTDIR, EBADF, ELOOP
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
penguindustin96466302019-05-06 14:57:17 -040037# EBADF - guard against macOS `stat` throwing EBADF
Jörg Stucked5c120f2019-05-21 19:44:40 +020038_IGNORED_ERROS = (ENOENT, ENOTDIR, EBADF, ELOOP)
Przemysław Spodymek216b7452018-08-27 23:33:45 +020039
Steve Dower2f6fae62019-02-03 23:08:18 -080040_IGNORED_WINERRORS = (
41 21, # ERROR_NOT_READY - drive exists but is not accessible
Jörg Stucked5c120f2019-05-21 19:44:40 +020042 1921, # ERROR_CANT_RESOLVE_FILENAME - fix for broken symlink pointing to itself
Steve Dower2f6fae62019-02-03 23:08:18 -080043)
44
45def _ignore_error(exception):
46 return (getattr(exception, 'errno', None) in _IGNORED_ERROS or
47 getattr(exception, 'winerror', None) in _IGNORED_WINERRORS)
48
49
Antoine Pitrou31119e42013-11-22 17:38:12 +010050def _is_wildcard_pattern(pat):
51 # Whether this pattern needs actual matching using fnmatch, or can
52 # be looked up directly as a file.
53 return "*" in pat or "?" in pat or "[" in pat
54
55
56class _Flavour(object):
57 """A flavour implements a particular (platform-specific) set of path
58 semantics."""
59
60 def __init__(self):
61 self.join = self.sep.join
62
63 def parse_parts(self, parts):
64 parsed = []
65 sep = self.sep
66 altsep = self.altsep
67 drv = root = ''
68 it = reversed(parts)
69 for part in it:
70 if not part:
71 continue
72 if altsep:
73 part = part.replace(altsep, sep)
74 drv, root, rel = self.splitroot(part)
75 if sep in rel:
76 for x in reversed(rel.split(sep)):
77 if x and x != '.':
78 parsed.append(sys.intern(x))
79 else:
80 if rel and rel != '.':
81 parsed.append(sys.intern(rel))
82 if drv or root:
83 if not drv:
84 # If no drive is present, try to find one in the previous
85 # parts. This makes the result of parsing e.g.
86 # ("C:", "/", "a") reasonably intuitive.
87 for part in it:
Antoine Pitrou57fffd62015-02-15 18:03:59 +010088 if not part:
89 continue
90 if altsep:
91 part = part.replace(altsep, sep)
Antoine Pitrou31119e42013-11-22 17:38:12 +010092 drv = self.splitroot(part)[0]
93 if drv:
94 break
95 break
96 if drv or root:
97 parsed.append(drv + root)
98 parsed.reverse()
99 return drv, root, parsed
100
101 def join_parsed_parts(self, drv, root, parts, drv2, root2, parts2):
102 """
103 Join the two paths represented by the respective
104 (drive, root, parts) tuples. Return a new (drive, root, parts) tuple.
105 """
106 if root2:
Serhiy Storchakaa9939022013-12-06 17:14:12 +0200107 if not drv2 and drv:
108 return drv, root2, [drv + root2] + parts2[1:]
109 elif drv2:
110 if drv2 == drv or self.casefold(drv2) == self.casefold(drv):
111 # Same drive => second path is relative to the first
112 return drv, root, parts + parts2[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100113 else:
Serhiy Storchakaa9939022013-12-06 17:14:12 +0200114 # Second path is non-anchored (common case)
115 return drv, root, parts + parts2
116 return drv2, root2, parts2
Antoine Pitrou31119e42013-11-22 17:38:12 +0100117
118
119class _WindowsFlavour(_Flavour):
120 # Reference for Windows paths can be found at
121 # http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
122
123 sep = '\\'
124 altsep = '/'
125 has_drv = True
126 pathmod = ntpath
127
Antoine Pitroudb118f52014-11-19 00:32:08 +0100128 is_supported = (os.name == 'nt')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100129
Jon Dufresne39726282017-05-18 07:35:54 -0700130 drive_letters = set('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100131 ext_namespace_prefix = '\\\\?\\'
132
133 reserved_names = (
134 {'CON', 'PRN', 'AUX', 'NUL'} |
135 {'COM%d' % i for i in range(1, 10)} |
136 {'LPT%d' % i for i in range(1, 10)}
137 )
138
139 # Interesting findings about extended paths:
140 # - '\\?\c:\a', '//?/c:\a' and '//?/c:/a' are all supported
141 # but '\\?\c:/a' is not
142 # - extended paths are always absolute; "relative" extended paths will
143 # fail.
144
145 def splitroot(self, part, sep=sep):
146 first = part[0:1]
147 second = part[1:2]
148 if (second == sep and first == sep):
149 # XXX extended paths should also disable the collapsing of "."
150 # components (according to MSDN docs).
151 prefix, part = self._split_extended_path(part)
152 first = part[0:1]
153 second = part[1:2]
154 else:
155 prefix = ''
156 third = part[2:3]
157 if (second == sep and first == sep and third != sep):
158 # is a UNC path:
159 # vvvvvvvvvvvvvvvvvvvvv root
160 # \\machine\mountpoint\directory\etc\...
161 # directory ^^^^^^^^^^^^^^
162 index = part.find(sep, 2)
163 if index != -1:
164 index2 = part.find(sep, index + 1)
165 # a UNC path can't have two slashes in a row
166 # (after the initial two)
167 if index2 != index + 1:
168 if index2 == -1:
169 index2 = len(part)
170 if prefix:
171 return prefix + part[1:index2], sep, part[index2+1:]
172 else:
173 return part[:index2], sep, part[index2+1:]
174 drv = root = ''
175 if second == ':' and first in self.drive_letters:
176 drv = part[:2]
177 part = part[2:]
178 first = third
179 if first == sep:
180 root = first
181 part = part.lstrip(sep)
182 return prefix + drv, root, part
183
184 def casefold(self, s):
185 return s.lower()
186
187 def casefold_parts(self, parts):
188 return [p.lower() for p in parts]
189
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300190 def compile_pattern(self, pattern):
191 return re.compile(fnmatch.translate(pattern), re.IGNORECASE).fullmatch
192
Steve Dower98eb3602016-11-09 12:58:17 -0800193 def resolve(self, path, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100194 s = str(path)
195 if not s:
196 return os.getcwd()
Steve Dower98eb3602016-11-09 12:58:17 -0800197 previous_s = None
Antoine Pitrou31119e42013-11-22 17:38:12 +0100198 if _getfinalpathname is not None:
Steve Dower98eb3602016-11-09 12:58:17 -0800199 if strict:
200 return self._ext_to_normal(_getfinalpathname(s))
201 else:
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200202 tail_parts = [] # End of the path after the first one not found
Steve Dower98eb3602016-11-09 12:58:17 -0800203 while True:
204 try:
205 s = self._ext_to_normal(_getfinalpathname(s))
206 except FileNotFoundError:
207 previous_s = s
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200208 s, tail = os.path.split(s)
209 tail_parts.append(tail)
Steve Dower4b1e98b2016-12-28 16:02:59 -0800210 if previous_s == s:
211 return path
Steve Dower98eb3602016-11-09 12:58:17 -0800212 else:
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200213 return os.path.join(s, *reversed(tail_parts))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100214 # Means fallback on absolute
215 return None
216
217 def _split_extended_path(self, s, ext_prefix=ext_namespace_prefix):
218 prefix = ''
219 if s.startswith(ext_prefix):
220 prefix = s[:4]
221 s = s[4:]
222 if s.startswith('UNC\\'):
223 prefix += s[:3]
224 s = '\\' + s[3:]
225 return prefix, s
226
227 def _ext_to_normal(self, s):
228 # Turn back an extended path into a normal DOS-like path
229 return self._split_extended_path(s)[1]
230
231 def is_reserved(self, parts):
232 # NOTE: the rules for reserved names seem somewhat complicated
233 # (e.g. r"..\NUL" is reserved but not r"foo\NUL").
234 # We err on the side of caution and return True for paths which are
235 # not considered reserved by Windows.
236 if not parts:
237 return False
238 if parts[0].startswith('\\\\'):
239 # UNC paths are never reserved
240 return False
241 return parts[-1].partition('.')[0].upper() in self.reserved_names
242
243 def make_uri(self, path):
244 # Under Windows, file URIs use the UTF-8 encoding.
245 drive = path.drive
246 if len(drive) == 2 and drive[1] == ':':
247 # It's a path on a local drive => 'file:///c:/a/b'
248 rest = path.as_posix()[2:].lstrip('/')
249 return 'file:///%s/%s' % (
250 drive, urlquote_from_bytes(rest.encode('utf-8')))
251 else:
252 # It's a path on a network drive => 'file://host/share/a/b'
253 return 'file:' + urlquote_from_bytes(path.as_posix().encode('utf-8'))
254
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100255 def gethomedir(self, username):
256 if 'HOME' in os.environ:
257 userhome = os.environ['HOME']
258 elif 'USERPROFILE' in os.environ:
259 userhome = os.environ['USERPROFILE']
260 elif 'HOMEPATH' in os.environ:
Antoine Pitrou5d4e27e2014-12-30 22:09:42 +0100261 try:
262 drv = os.environ['HOMEDRIVE']
263 except KeyError:
264 drv = ''
265 userhome = drv + os.environ['HOMEPATH']
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100266 else:
267 raise RuntimeError("Can't determine home directory")
268
269 if username:
270 # Try to guess user home directory. By default all users
271 # directories are located in the same place and are named by
272 # corresponding usernames. If current user home directory points
273 # to nonstandard place, this guess is likely wrong.
274 if os.environ['USERNAME'] != username:
275 drv, root, parts = self.parse_parts((userhome,))
276 if parts[-1] != os.environ['USERNAME']:
277 raise RuntimeError("Can't determine home directory "
278 "for %r" % username)
279 parts[-1] = username
280 if drv or root:
281 userhome = drv + root + self.join(parts[1:])
282 else:
283 userhome = self.join(parts)
284 return userhome
Antoine Pitrou31119e42013-11-22 17:38:12 +0100285
286class _PosixFlavour(_Flavour):
287 sep = '/'
288 altsep = ''
289 has_drv = False
290 pathmod = posixpath
291
292 is_supported = (os.name != 'nt')
293
294 def splitroot(self, part, sep=sep):
295 if part and part[0] == sep:
296 stripped_part = part.lstrip(sep)
297 # According to POSIX path resolution:
298 # http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11
299 # "A pathname that begins with two successive slashes may be
300 # interpreted in an implementation-defined manner, although more
301 # than two leading slashes shall be treated as a single slash".
302 if len(part) - len(stripped_part) == 2:
303 return '', sep * 2, stripped_part
304 else:
305 return '', sep, stripped_part
306 else:
307 return '', '', part
308
309 def casefold(self, s):
310 return s
311
312 def casefold_parts(self, parts):
313 return parts
314
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300315 def compile_pattern(self, pattern):
316 return re.compile(fnmatch.translate(pattern)).fullmatch
317
Steve Dower98eb3602016-11-09 12:58:17 -0800318 def resolve(self, path, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100319 sep = self.sep
Antoine Pitrou31119e42013-11-22 17:38:12 +0100320 accessor = path._accessor
Antoine Pitrouc274fd22013-12-16 19:57:41 +0100321 seen = {}
322 def _resolve(path, rest):
323 if rest.startswith(sep):
324 path = ''
325
326 for name in rest.split(sep):
327 if not name or name == '.':
328 # current dir
329 continue
330 if name == '..':
331 # parent dir
332 path, _, _ = path.rpartition(sep)
333 continue
334 newpath = path + sep + name
335 if newpath in seen:
336 # Already seen this path
337 path = seen[newpath]
338 if path is not None:
339 # use cached value
340 continue
341 # The symlink is not resolved, so we must have a symlink loop.
342 raise RuntimeError("Symlink loop from %r" % newpath)
343 # Resolve the symbolic link
344 try:
345 target = accessor.readlink(newpath)
346 except OSError as e:
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200347 if e.errno != EINVAL and strict:
348 raise
349 # Not a symlink, or non-strict mode. We just leave the path
350 # untouched.
Antoine Pitrouc274fd22013-12-16 19:57:41 +0100351 path = newpath
352 else:
353 seen[newpath] = None # not resolved symlink
354 path = _resolve(path, target)
355 seen[newpath] = path # resolved symlink
356
357 return path
358 # NOTE: according to POSIX, getcwd() cannot contain path components
359 # which are symlinks.
360 base = '' if path.is_absolute() else os.getcwd()
361 return _resolve(base, str(path)) or sep
Antoine Pitrou31119e42013-11-22 17:38:12 +0100362
363 def is_reserved(self, parts):
364 return False
365
366 def make_uri(self, path):
367 # We represent the path using the local filesystem encoding,
368 # for portability to other applications.
369 bpath = bytes(path)
370 return 'file://' + urlquote_from_bytes(bpath)
371
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100372 def gethomedir(self, username):
373 if not username:
374 try:
375 return os.environ['HOME']
376 except KeyError:
377 import pwd
378 return pwd.getpwuid(os.getuid()).pw_dir
379 else:
380 import pwd
381 try:
382 return pwd.getpwnam(username).pw_dir
383 except KeyError:
384 raise RuntimeError("Can't determine home directory "
385 "for %r" % username)
386
Antoine Pitrou31119e42013-11-22 17:38:12 +0100387
388_windows_flavour = _WindowsFlavour()
389_posix_flavour = _PosixFlavour()
390
391
392class _Accessor:
393 """An accessor implements a particular (system-specific or not) way of
394 accessing paths on the filesystem."""
395
396
397class _NormalAccessor(_Accessor):
398
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200399 stat = os.stat
Antoine Pitrou31119e42013-11-22 17:38:12 +0100400
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200401 lstat = os.lstat
Antoine Pitrou31119e42013-11-22 17:38:12 +0100402
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200403 open = os.open
Antoine Pitrou31119e42013-11-22 17:38:12 +0100404
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200405 listdir = os.listdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100406
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200407 scandir = os.scandir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100408
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200409 chmod = os.chmod
Antoine Pitrou31119e42013-11-22 17:38:12 +0100410
411 if hasattr(os, "lchmod"):
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200412 lchmod = os.lchmod
Antoine Pitrou31119e42013-11-22 17:38:12 +0100413 else:
414 def lchmod(self, pathobj, mode):
415 raise NotImplementedError("lchmod() not available on this system")
416
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200417 mkdir = os.mkdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100418
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200419 unlink = os.unlink
Antoine Pitrou31119e42013-11-22 17:38:12 +0100420
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -0400421 link_to = os.link
422
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200423 rmdir = os.rmdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100424
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200425 rename = os.rename
Antoine Pitrou31119e42013-11-22 17:38:12 +0100426
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200427 replace = os.replace
Antoine Pitrou31119e42013-11-22 17:38:12 +0100428
429 if nt:
430 if supports_symlinks:
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200431 symlink = os.symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +0100432 else:
433 def symlink(a, b, target_is_directory):
434 raise NotImplementedError("symlink() not available on this system")
435 else:
436 # Under POSIX, os.symlink() takes two args
437 @staticmethod
438 def symlink(a, b, target_is_directory):
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200439 return os.symlink(a, b)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100440
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200441 utime = os.utime
Antoine Pitrou31119e42013-11-22 17:38:12 +0100442
443 # Helper for resolve()
444 def readlink(self, path):
445 return os.readlink(path)
446
447
448_normal_accessor = _NormalAccessor()
449
450
451#
452# Globbing helpers
453#
454
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300455def _make_selector(pattern_parts, flavour):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100456 pat = pattern_parts[0]
457 child_parts = pattern_parts[1:]
458 if pat == '**':
459 cls = _RecursiveWildcardSelector
460 elif '**' in pat:
461 raise ValueError("Invalid pattern: '**' can only be an entire path component")
462 elif _is_wildcard_pattern(pat):
463 cls = _WildcardSelector
464 else:
465 cls = _PreciseSelector
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300466 return cls(pat, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100467
468if hasattr(functools, "lru_cache"):
469 _make_selector = functools.lru_cache()(_make_selector)
470
471
472class _Selector:
473 """A selector matches a specific glob pattern part against the children
474 of a given path."""
475
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300476 def __init__(self, child_parts, flavour):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100477 self.child_parts = child_parts
478 if child_parts:
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300479 self.successor = _make_selector(child_parts, flavour)
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300480 self.dironly = True
Antoine Pitrou31119e42013-11-22 17:38:12 +0100481 else:
482 self.successor = _TerminatingSelector()
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300483 self.dironly = False
Antoine Pitrou31119e42013-11-22 17:38:12 +0100484
485 def select_from(self, parent_path):
486 """Iterate over all child paths of `parent_path` matched by this
487 selector. This can contain parent_path itself."""
488 path_cls = type(parent_path)
489 is_dir = path_cls.is_dir
490 exists = path_cls.exists
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300491 scandir = parent_path._accessor.scandir
492 if not is_dir(parent_path):
493 return iter([])
494 return self._select_from(parent_path, is_dir, exists, scandir)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100495
496
497class _TerminatingSelector:
498
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300499 def _select_from(self, parent_path, is_dir, exists, scandir):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100500 yield parent_path
501
502
503class _PreciseSelector(_Selector):
504
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300505 def __init__(self, name, child_parts, flavour):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100506 self.name = name
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300507 _Selector.__init__(self, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100508
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300509 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800510 try:
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800511 path = parent_path._make_child_relpath(self.name)
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300512 if (is_dir if self.dironly else exists)(path):
513 for p in self.successor._select_from(path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800514 yield p
515 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100516 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100517
518
519class _WildcardSelector(_Selector):
520
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300521 def __init__(self, pat, child_parts, flavour):
522 self.match = flavour.compile_pattern(pat)
523 _Selector.__init__(self, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100524
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300525 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800526 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300527 entries = list(scandir(parent_path))
528 for entry in entries:
Jörg Stucked5c120f2019-05-21 19:44:40 +0200529 entry_is_dir = False
530 try:
531 entry_is_dir = entry.is_dir()
532 except OSError as e:
533 if not _ignore_error(e):
534 raise
535 if not self.dironly or entry_is_dir:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300536 name = entry.name
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300537 if self.match(name):
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300538 path = parent_path._make_child_relpath(name)
539 for p in self.successor._select_from(path, is_dir, exists, scandir):
540 yield p
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800541 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100542 return
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800543
Antoine Pitrou31119e42013-11-22 17:38:12 +0100544
545
546class _RecursiveWildcardSelector(_Selector):
547
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +0300548 def __init__(self, pat, child_parts, flavour):
549 _Selector.__init__(self, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100550
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300551 def _iterate_directories(self, parent_path, is_dir, scandir):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100552 yield parent_path
Guido van Rossumbc9fdda2016-01-07 10:56:36 -0800553 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300554 entries = list(scandir(parent_path))
555 for entry in entries:
Przemysław Spodymek216b7452018-08-27 23:33:45 +0200556 entry_is_dir = False
557 try:
558 entry_is_dir = entry.is_dir()
559 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -0800560 if not _ignore_error(e):
Przemysław Spodymek216b7452018-08-27 23:33:45 +0200561 raise
562 if entry_is_dir and not entry.is_symlink():
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300563 path = parent_path._make_child_relpath(entry.name)
564 for p in self._iterate_directories(path, is_dir, scandir):
Guido van Rossumbc9fdda2016-01-07 10:56:36 -0800565 yield p
566 except PermissionError:
567 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100568
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300569 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800570 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300571 yielded = set()
572 try:
573 successor_select = self.successor._select_from
574 for starting_point in self._iterate_directories(parent_path, is_dir, scandir):
575 for p in successor_select(starting_point, is_dir, exists, scandir):
576 if p not in yielded:
577 yield p
578 yielded.add(p)
579 finally:
580 yielded.clear()
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800581 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100582 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100583
584
585#
586# Public API
587#
588
589class _PathParents(Sequence):
590 """This object provides sequence-like access to the logical ancestors
591 of a path. Don't try to construct it yourself."""
592 __slots__ = ('_pathcls', '_drv', '_root', '_parts')
593
594 def __init__(self, path):
595 # We don't store the instance to avoid reference cycles
596 self._pathcls = type(path)
597 self._drv = path._drv
598 self._root = path._root
599 self._parts = path._parts
600
601 def __len__(self):
602 if self._drv or self._root:
603 return len(self._parts) - 1
604 else:
605 return len(self._parts)
606
607 def __getitem__(self, idx):
608 if idx < 0 or idx >= len(self):
609 raise IndexError(idx)
610 return self._pathcls._from_parsed_parts(self._drv, self._root,
611 self._parts[:-idx - 1])
612
613 def __repr__(self):
614 return "<{}.parents>".format(self._pathcls.__name__)
615
616
617class PurePath(object):
chasondfa015c2018-02-19 08:36:32 +0900618 """Base class for manipulating paths without I/O.
619
620 PurePath represents a filesystem path and offers operations which
Antoine Pitrou31119e42013-11-22 17:38:12 +0100621 don't imply any actual filesystem I/O. Depending on your system,
622 instantiating a PurePath will return either a PurePosixPath or a
623 PureWindowsPath object. You can also instantiate either of these classes
624 directly, regardless of your system.
625 """
626 __slots__ = (
627 '_drv', '_root', '_parts',
628 '_str', '_hash', '_pparts', '_cached_cparts',
629 )
630
631 def __new__(cls, *args):
632 """Construct a PurePath from one or several strings and or existing
633 PurePath objects. The strings and path objects are combined so as
634 to yield a canonicalized path, which is incorporated into the
635 new PurePath object.
636 """
637 if cls is PurePath:
638 cls = PureWindowsPath if os.name == 'nt' else PurePosixPath
639 return cls._from_parts(args)
640
641 def __reduce__(self):
642 # Using the parts tuple helps share interned path parts
643 # when pickling related paths.
644 return (self.__class__, tuple(self._parts))
645
646 @classmethod
647 def _parse_args(cls, args):
648 # This is useful when you don't want to create an instance, just
649 # canonicalize some constructor arguments.
650 parts = []
651 for a in args:
652 if isinstance(a, PurePath):
653 parts += a._parts
Antoine Pitrou31119e42013-11-22 17:38:12 +0100654 else:
Brett Cannon568be632016-06-10 12:20:49 -0700655 a = os.fspath(a)
656 if isinstance(a, str):
657 # Force-cast str subclasses to str (issue #21127)
658 parts.append(str(a))
659 else:
660 raise TypeError(
661 "argument should be a str object or an os.PathLike "
662 "object returning str, not %r"
663 % type(a))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100664 return cls._flavour.parse_parts(parts)
665
666 @classmethod
667 def _from_parts(cls, args, init=True):
668 # We need to call _parse_args on the instance, so as to get the
669 # right flavour.
670 self = object.__new__(cls)
671 drv, root, parts = self._parse_args(args)
672 self._drv = drv
673 self._root = root
674 self._parts = parts
675 if init:
676 self._init()
677 return self
678
679 @classmethod
680 def _from_parsed_parts(cls, drv, root, parts, init=True):
681 self = object.__new__(cls)
682 self._drv = drv
683 self._root = root
684 self._parts = parts
685 if init:
686 self._init()
687 return self
688
689 @classmethod
690 def _format_parsed_parts(cls, drv, root, parts):
691 if drv or root:
692 return drv + root + cls._flavour.join(parts[1:])
693 else:
694 return cls._flavour.join(parts)
695
696 def _init(self):
Martin Pantere26da7c2016-06-02 10:07:09 +0000697 # Overridden in concrete Path
Antoine Pitrou31119e42013-11-22 17:38:12 +0100698 pass
699
700 def _make_child(self, args):
701 drv, root, parts = self._parse_args(args)
702 drv, root, parts = self._flavour.join_parsed_parts(
703 self._drv, self._root, self._parts, drv, root, parts)
704 return self._from_parsed_parts(drv, root, parts)
705
706 def __str__(self):
707 """Return the string representation of the path, suitable for
708 passing to system calls."""
709 try:
710 return self._str
711 except AttributeError:
712 self._str = self._format_parsed_parts(self._drv, self._root,
713 self._parts) or '.'
714 return self._str
715
Brett Cannon568be632016-06-10 12:20:49 -0700716 def __fspath__(self):
717 return str(self)
718
Antoine Pitrou31119e42013-11-22 17:38:12 +0100719 def as_posix(self):
720 """Return the string representation of the path with forward (/)
721 slashes."""
722 f = self._flavour
723 return str(self).replace(f.sep, '/')
724
725 def __bytes__(self):
726 """Return the bytes representation of the path. This is only
727 recommended to use under Unix."""
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200728 return os.fsencode(self)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100729
730 def __repr__(self):
731 return "{}({!r})".format(self.__class__.__name__, self.as_posix())
732
733 def as_uri(self):
734 """Return the path as a 'file' URI."""
735 if not self.is_absolute():
736 raise ValueError("relative path can't be expressed as a file URI")
737 return self._flavour.make_uri(self)
738
739 @property
740 def _cparts(self):
741 # Cached casefolded parts, for hashing and comparison
742 try:
743 return self._cached_cparts
744 except AttributeError:
745 self._cached_cparts = self._flavour.casefold_parts(self._parts)
746 return self._cached_cparts
747
748 def __eq__(self, other):
749 if not isinstance(other, PurePath):
750 return NotImplemented
751 return self._cparts == other._cparts and self._flavour is other._flavour
752
Antoine Pitrou31119e42013-11-22 17:38:12 +0100753 def __hash__(self):
754 try:
755 return self._hash
756 except AttributeError:
757 self._hash = hash(tuple(self._cparts))
758 return self._hash
759
760 def __lt__(self, other):
761 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
762 return NotImplemented
763 return self._cparts < other._cparts
764
765 def __le__(self, other):
766 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
767 return NotImplemented
768 return self._cparts <= other._cparts
769
770 def __gt__(self, other):
771 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
772 return NotImplemented
773 return self._cparts > other._cparts
774
775 def __ge__(self, other):
776 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
777 return NotImplemented
778 return self._cparts >= other._cparts
779
780 drive = property(attrgetter('_drv'),
781 doc="""The drive prefix (letter or UNC path), if any.""")
782
783 root = property(attrgetter('_root'),
784 doc="""The root of the path, if any.""")
785
786 @property
787 def anchor(self):
788 """The concatenation of the drive and root, or ''."""
789 anchor = self._drv + self._root
790 return anchor
791
792 @property
793 def name(self):
794 """The final path component, if any."""
795 parts = self._parts
796 if len(parts) == (1 if (self._drv or self._root) else 0):
797 return ''
798 return parts[-1]
799
800 @property
801 def suffix(self):
802 """The final component's last suffix, if any."""
803 name = self.name
804 i = name.rfind('.')
805 if 0 < i < len(name) - 1:
806 return name[i:]
807 else:
808 return ''
809
810 @property
811 def suffixes(self):
812 """A list of the final component's suffixes, if any."""
813 name = self.name
814 if name.endswith('.'):
815 return []
816 name = name.lstrip('.')
817 return ['.' + suffix for suffix in name.split('.')[1:]]
818
819 @property
820 def stem(self):
821 """The final path component, minus its last suffix."""
822 name = self.name
823 i = name.rfind('.')
824 if 0 < i < len(name) - 1:
825 return name[:i]
826 else:
827 return name
828
829 def with_name(self, name):
830 """Return a new path with the file name changed."""
831 if not self.name:
832 raise ValueError("%r has an empty name" % (self,))
Antoine Pitrou7084e732014-07-06 21:31:12 -0400833 drv, root, parts = self._flavour.parse_parts((name,))
834 if (not name or name[-1] in [self._flavour.sep, self._flavour.altsep]
835 or drv or root or len(parts) != 1):
836 raise ValueError("Invalid name %r" % (name))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100837 return self._from_parsed_parts(self._drv, self._root,
838 self._parts[:-1] + [name])
839
840 def with_suffix(self, suffix):
Stefan Otte46dc4e32018-08-03 22:49:42 +0200841 """Return a new path with the file suffix changed. If the path
842 has no suffix, add given suffix. If the given suffix is an empty
843 string, remove the suffix from the path.
844 """
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400845 f = self._flavour
846 if f.sep in suffix or f.altsep and f.altsep in suffix:
Berker Peksag423d05f2018-08-11 08:45:06 +0300847 raise ValueError("Invalid suffix %r" % (suffix,))
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400848 if suffix and not suffix.startswith('.') or suffix == '.':
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100849 raise ValueError("Invalid suffix %r" % (suffix))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100850 name = self.name
851 if not name:
852 raise ValueError("%r has an empty name" % (self,))
853 old_suffix = self.suffix
854 if not old_suffix:
855 name = name + suffix
856 else:
857 name = name[:-len(old_suffix)] + suffix
858 return self._from_parsed_parts(self._drv, self._root,
859 self._parts[:-1] + [name])
860
861 def relative_to(self, *other):
862 """Return the relative path to another path identified by the passed
863 arguments. If the operation is not possible (because this is not
864 a subpath of the other path), raise ValueError.
865 """
866 # For the purpose of this method, drive and root are considered
867 # separate parts, i.e.:
868 # Path('c:/').relative_to('c:') gives Path('/')
869 # Path('c:/').relative_to('/') raise ValueError
870 if not other:
871 raise TypeError("need at least one argument")
872 parts = self._parts
873 drv = self._drv
874 root = self._root
Antoine Pitrou156b3612013-12-28 19:49:04 +0100875 if root:
876 abs_parts = [drv, root] + parts[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100877 else:
878 abs_parts = parts
879 to_drv, to_root, to_parts = self._parse_args(other)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100880 if to_root:
881 to_abs_parts = [to_drv, to_root] + to_parts[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100882 else:
883 to_abs_parts = to_parts
884 n = len(to_abs_parts)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100885 cf = self._flavour.casefold_parts
886 if (root or drv) if n == 0 else cf(abs_parts[:n]) != cf(to_abs_parts):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100887 formatted = self._format_parsed_parts(to_drv, to_root, to_parts)
888 raise ValueError("{!r} does not start with {!r}"
889 .format(str(self), str(formatted)))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100890 return self._from_parsed_parts('', root if n == 1 else '',
891 abs_parts[n:])
Antoine Pitrou31119e42013-11-22 17:38:12 +0100892
Hai Shi82642a02019-08-13 14:54:02 -0500893 def is_relative_to(self, *other):
894 """Return True if the path is relative to another path or False.
895 """
896 try:
897 self.relative_to(*other)
898 return True
899 except ValueError:
900 return False
901
Antoine Pitrou31119e42013-11-22 17:38:12 +0100902 @property
903 def parts(self):
904 """An object providing sequence-like access to the
905 components in the filesystem path."""
906 # We cache the tuple to avoid building a new one each time .parts
907 # is accessed. XXX is this necessary?
908 try:
909 return self._pparts
910 except AttributeError:
911 self._pparts = tuple(self._parts)
912 return self._pparts
913
914 def joinpath(self, *args):
915 """Combine this path with one or several arguments, and return a
916 new path representing either a subpath (if all arguments are relative
917 paths) or a totally different path (if one of the arguments is
918 anchored).
919 """
920 return self._make_child(args)
921
922 def __truediv__(self, key):
aiudirog4c69be22019-08-08 01:41:10 -0400923 try:
924 return self._make_child((key,))
925 except TypeError:
926 return NotImplemented
Antoine Pitrou31119e42013-11-22 17:38:12 +0100927
928 def __rtruediv__(self, key):
aiudirog4c69be22019-08-08 01:41:10 -0400929 try:
930 return self._from_parts([key] + self._parts)
931 except TypeError:
932 return NotImplemented
Antoine Pitrou31119e42013-11-22 17:38:12 +0100933
934 @property
935 def parent(self):
936 """The logical parent of the path."""
937 drv = self._drv
938 root = self._root
939 parts = self._parts
940 if len(parts) == 1 and (drv or root):
941 return self
942 return self._from_parsed_parts(drv, root, parts[:-1])
943
944 @property
945 def parents(self):
946 """A sequence of this path's logical parents."""
947 return _PathParents(self)
948
949 def is_absolute(self):
950 """True if the path is absolute (has both a root and, if applicable,
951 a drive)."""
952 if not self._root:
953 return False
954 return not self._flavour.has_drv or bool(self._drv)
955
956 def is_reserved(self):
957 """Return True if the path contains one of the special names reserved
958 by the system, if any."""
959 return self._flavour.is_reserved(self._parts)
960
961 def match(self, path_pattern):
962 """
963 Return True if this path matches the given pattern.
964 """
965 cf = self._flavour.casefold
966 path_pattern = cf(path_pattern)
967 drv, root, pat_parts = self._flavour.parse_parts((path_pattern,))
968 if not pat_parts:
969 raise ValueError("empty pattern")
970 if drv and drv != cf(self._drv):
971 return False
972 if root and root != cf(self._root):
973 return False
974 parts = self._cparts
975 if drv or root:
976 if len(pat_parts) != len(parts):
977 return False
978 pat_parts = pat_parts[1:]
979 elif len(pat_parts) > len(parts):
980 return False
981 for part, pat in zip(reversed(parts), reversed(pat_parts)):
982 if not fnmatch.fnmatchcase(part, pat):
983 return False
984 return True
985
Brett Cannon568be632016-06-10 12:20:49 -0700986# Can't subclass os.PathLike from PurePath and keep the constructor
987# optimizations in PurePath._parse_args().
988os.PathLike.register(PurePath)
989
Antoine Pitrou31119e42013-11-22 17:38:12 +0100990
991class PurePosixPath(PurePath):
chasondfa015c2018-02-19 08:36:32 +0900992 """PurePath subclass for non-Windows systems.
993
994 On a POSIX system, instantiating a PurePath should return this object.
995 However, you can also instantiate it directly on any system.
996 """
Antoine Pitrou31119e42013-11-22 17:38:12 +0100997 _flavour = _posix_flavour
998 __slots__ = ()
999
1000
1001class PureWindowsPath(PurePath):
chasondfa015c2018-02-19 08:36:32 +09001002 """PurePath subclass for Windows systems.
1003
1004 On a Windows system, instantiating a PurePath should return this object.
1005 However, you can also instantiate it directly on any system.
1006 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001007 _flavour = _windows_flavour
1008 __slots__ = ()
1009
1010
1011# Filesystem-accessing classes
1012
1013
1014class Path(PurePath):
chasondfa015c2018-02-19 08:36:32 +09001015 """PurePath subclass that can make system calls.
1016
1017 Path represents a filesystem path but unlike PurePath, also offers
1018 methods to do system calls on path objects. Depending on your system,
1019 instantiating a Path will return either a PosixPath or a WindowsPath
1020 object. You can also instantiate a PosixPath or WindowsPath directly,
1021 but cannot instantiate a WindowsPath on a POSIX system or vice versa.
1022 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001023 __slots__ = (
1024 '_accessor',
1025 '_closed',
1026 )
1027
1028 def __new__(cls, *args, **kwargs):
1029 if cls is Path:
1030 cls = WindowsPath if os.name == 'nt' else PosixPath
1031 self = cls._from_parts(args, init=False)
1032 if not self._flavour.is_supported:
1033 raise NotImplementedError("cannot instantiate %r on your system"
1034 % (cls.__name__,))
1035 self._init()
1036 return self
1037
1038 def _init(self,
1039 # Private non-constructor arguments
1040 template=None,
1041 ):
1042 self._closed = False
1043 if template is not None:
1044 self._accessor = template._accessor
1045 else:
1046 self._accessor = _normal_accessor
1047
1048 def _make_child_relpath(self, part):
1049 # This is an optimization used for dir walking. `part` must be
1050 # a single part relative to this path.
1051 parts = self._parts + [part]
1052 return self._from_parsed_parts(self._drv, self._root, parts)
1053
1054 def __enter__(self):
1055 if self._closed:
1056 self._raise_closed()
1057 return self
1058
1059 def __exit__(self, t, v, tb):
1060 self._closed = True
1061
1062 def _raise_closed(self):
1063 raise ValueError("I/O operation on closed path")
1064
1065 def _opener(self, name, flags, mode=0o666):
1066 # A stub for the opener argument to built-in open()
1067 return self._accessor.open(self, flags, mode)
1068
Antoine Pitrou4a60d422013-12-02 21:25:18 +01001069 def _raw_open(self, flags, mode=0o777):
1070 """
1071 Open the file pointed by this path and return a file descriptor,
1072 as os.open() does.
1073 """
1074 if self._closed:
1075 self._raise_closed()
1076 return self._accessor.open(self, flags, mode)
1077
Antoine Pitrou31119e42013-11-22 17:38:12 +01001078 # Public API
1079
1080 @classmethod
1081 def cwd(cls):
1082 """Return a new path pointing to the current working directory
1083 (as returned by os.getcwd()).
1084 """
1085 return cls(os.getcwd())
1086
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001087 @classmethod
1088 def home(cls):
1089 """Return a new path pointing to the user's home directory (as
1090 returned by os.path.expanduser('~')).
1091 """
1092 return cls(cls()._flavour.gethomedir(None))
1093
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001094 def samefile(self, other_path):
Berker Peksag05492b82015-10-22 03:34:16 +03001095 """Return whether other_path is the same or not as this file
Berker Peksag267597f2015-10-21 20:10:24 +03001096 (as returned by os.path.samefile()).
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001097 """
1098 st = self.stat()
1099 try:
1100 other_st = other_path.stat()
1101 except AttributeError:
1102 other_st = os.stat(other_path)
1103 return os.path.samestat(st, other_st)
1104
Antoine Pitrou31119e42013-11-22 17:38:12 +01001105 def iterdir(self):
1106 """Iterate over the files in this directory. Does not yield any
1107 result for the special paths '.' and '..'.
1108 """
1109 if self._closed:
1110 self._raise_closed()
1111 for name in self._accessor.listdir(self):
1112 if name in {'.', '..'}:
1113 # Yielding a path object for these makes little sense
1114 continue
1115 yield self._make_child_relpath(name)
1116 if self._closed:
1117 self._raise_closed()
1118
1119 def glob(self, pattern):
1120 """Iterate over this subtree and yield all existing files (of any
Eivind Teig537b6ca2019-02-11 11:47:09 +01001121 kind, including directories) matching the given relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001122 """
Berker Peksag4a208e42016-01-30 17:50:48 +02001123 if not pattern:
1124 raise ValueError("Unacceptable pattern: {!r}".format(pattern))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001125 drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
1126 if drv or root:
1127 raise NotImplementedError("Non-relative patterns are unsupported")
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +03001128 selector = _make_selector(tuple(pattern_parts), self._flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001129 for p in selector.select_from(self):
1130 yield p
1131
1132 def rglob(self, pattern):
1133 """Recursively yield all existing files (of any kind, including
Eivind Teig537b6ca2019-02-11 11:47:09 +01001134 directories) matching the given relative pattern, anywhere in
1135 this subtree.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001136 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001137 drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
1138 if drv or root:
1139 raise NotImplementedError("Non-relative patterns are unsupported")
Serhiy Storchaka10ecbad2019-10-21 20:37:15 +03001140 selector = _make_selector(("**",) + tuple(pattern_parts), self._flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001141 for p in selector.select_from(self):
1142 yield p
1143
1144 def absolute(self):
1145 """Return an absolute version of this path. This function works
1146 even if the path doesn't point to anything.
1147
1148 No normalization is done, i.e. all '.' and '..' will be kept along.
1149 Use resolve() to get the canonical path to a file.
1150 """
1151 # XXX untested yet!
1152 if self._closed:
1153 self._raise_closed()
1154 if self.is_absolute():
1155 return self
1156 # FIXME this must defer to the specific flavour (and, under Windows,
1157 # use nt._getfullpathname())
1158 obj = self._from_parts([os.getcwd()] + self._parts, init=False)
1159 obj._init(template=self)
1160 return obj
1161
Steve Dower98eb3602016-11-09 12:58:17 -08001162 def resolve(self, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001163 """
1164 Make the path absolute, resolving all symlinks on the way and also
1165 normalizing it (for example turning slashes into backslashes under
1166 Windows).
1167 """
1168 if self._closed:
1169 self._raise_closed()
Steve Dower98eb3602016-11-09 12:58:17 -08001170 s = self._flavour.resolve(self, strict=strict)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001171 if s is None:
1172 # No symlink resolution => for consistency, raise an error if
1173 # the path doesn't exist or is forbidden
1174 self.stat()
1175 s = str(self.absolute())
1176 # Now we have no symlinks in the path, it's safe to normalize it.
1177 normed = self._flavour.pathmod.normpath(s)
1178 obj = self._from_parts((normed,), init=False)
1179 obj._init(template=self)
1180 return obj
1181
1182 def stat(self):
1183 """
1184 Return the result of the stat() system call on this path, like
1185 os.stat() does.
1186 """
1187 return self._accessor.stat(self)
1188
1189 def owner(self):
1190 """
1191 Return the login name of the file owner.
1192 """
1193 import pwd
1194 return pwd.getpwuid(self.stat().st_uid).pw_name
1195
1196 def group(self):
1197 """
1198 Return the group name of the file gid.
1199 """
1200 import grp
1201 return grp.getgrgid(self.stat().st_gid).gr_name
1202
Antoine Pitrou31119e42013-11-22 17:38:12 +01001203 def open(self, mode='r', buffering=-1, encoding=None,
1204 errors=None, newline=None):
1205 """
1206 Open the file pointed by this path and return a file object, as
1207 the built-in open() function does.
1208 """
1209 if self._closed:
1210 self._raise_closed()
Serhiy Storchaka62a99512017-03-25 13:42:11 +02001211 return io.open(self, mode, buffering, encoding, errors, newline,
Antoine Pitrou31119e42013-11-22 17:38:12 +01001212 opener=self._opener)
1213
Georg Brandlea683982014-10-01 19:12:33 +02001214 def read_bytes(self):
1215 """
1216 Open the file in bytes mode, read it, and close the file.
1217 """
1218 with self.open(mode='rb') as f:
1219 return f.read()
1220
1221 def read_text(self, encoding=None, errors=None):
1222 """
1223 Open the file in text mode, read it, and close the file.
1224 """
1225 with self.open(mode='r', encoding=encoding, errors=errors) as f:
1226 return f.read()
1227
1228 def write_bytes(self, data):
1229 """
1230 Open the file in bytes mode, write to it, and close the file.
1231 """
1232 # type-check for the buffer interface before truncating the file
1233 view = memoryview(data)
1234 with self.open(mode='wb') as f:
1235 return f.write(view)
1236
1237 def write_text(self, data, encoding=None, errors=None):
1238 """
1239 Open the file in text mode, write to it, and close the file.
1240 """
1241 if not isinstance(data, str):
1242 raise TypeError('data must be str, not %s' %
1243 data.__class__.__name__)
1244 with self.open(mode='w', encoding=encoding, errors=errors) as f:
1245 return f.write(data)
1246
Antoine Pitrou31119e42013-11-22 17:38:12 +01001247 def touch(self, mode=0o666, exist_ok=True):
1248 """
1249 Create this file with the given access mode, if it doesn't exist.
1250 """
1251 if self._closed:
1252 self._raise_closed()
1253 if exist_ok:
1254 # First try to bump modification time
1255 # Implementation note: GNU touch uses the UTIME_NOW option of
1256 # the utimensat() / futimens() functions.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001257 try:
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001258 self._accessor.utime(self, None)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001259 except OSError:
1260 # Avoid exception chaining
1261 pass
1262 else:
1263 return
1264 flags = os.O_CREAT | os.O_WRONLY
1265 if not exist_ok:
1266 flags |= os.O_EXCL
1267 fd = self._raw_open(flags, mode)
1268 os.close(fd)
1269
Barry Warsaw7c549c42014-08-05 11:28:12 -04001270 def mkdir(self, mode=0o777, parents=False, exist_ok=False):
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001271 """
1272 Create a new directory at this given path.
1273 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001274 if self._closed:
1275 self._raise_closed()
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001276 try:
1277 self._accessor.mkdir(self, mode)
1278 except FileNotFoundError:
1279 if not parents or self.parent == self:
1280 raise
Armin Rigo22a594a2017-04-13 20:08:15 +02001281 self.parent.mkdir(parents=True, exist_ok=True)
1282 self.mkdir(mode, parents=False, exist_ok=exist_ok)
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001283 except OSError:
1284 # Cannot rely on checking for EEXIST, since the operating system
1285 # could give priority to other errors like EACCES or EROFS
1286 if not exist_ok or not self.is_dir():
1287 raise
Antoine Pitrou31119e42013-11-22 17:38:12 +01001288
1289 def chmod(self, mode):
1290 """
1291 Change the permissions of the path, like os.chmod().
1292 """
1293 if self._closed:
1294 self._raise_closed()
1295 self._accessor.chmod(self, mode)
1296
1297 def lchmod(self, mode):
1298 """
1299 Like chmod(), except if the path points to a symlink, the symlink's
1300 permissions are changed, rather than its target's.
1301 """
1302 if self._closed:
1303 self._raise_closed()
1304 self._accessor.lchmod(self, mode)
1305
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001306 def unlink(self, missing_ok=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001307 """
1308 Remove this file or link.
1309 If the path is a directory, use rmdir() instead.
1310 """
1311 if self._closed:
1312 self._raise_closed()
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001313 try:
1314 self._accessor.unlink(self)
1315 except FileNotFoundError:
1316 if not missing_ok:
1317 raise
Antoine Pitrou31119e42013-11-22 17:38:12 +01001318
1319 def rmdir(self):
1320 """
1321 Remove this directory. The directory must be empty.
1322 """
1323 if self._closed:
1324 self._raise_closed()
1325 self._accessor.rmdir(self)
1326
1327 def lstat(self):
1328 """
1329 Like stat(), except if the path points to a symlink, the symlink's
1330 status information is returned, rather than its target's.
1331 """
1332 if self._closed:
1333 self._raise_closed()
1334 return self._accessor.lstat(self)
1335
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001336 def link_to(self, target):
1337 """
1338 Create a hard link pointing to a path named target.
1339 """
1340 if self._closed:
1341 self._raise_closed()
1342 self._accessor.link_to(self, target)
1343
Antoine Pitrou31119e42013-11-22 17:38:12 +01001344 def rename(self, target):
1345 """
hui shang088a09a2019-09-11 21:26:49 +08001346 Rename this path to the given path,
1347 and return a new Path instance pointing to the given path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001348 """
1349 if self._closed:
1350 self._raise_closed()
1351 self._accessor.rename(self, target)
hui shang088a09a2019-09-11 21:26:49 +08001352 return self.__class__(target)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001353
1354 def replace(self, target):
1355 """
1356 Rename this path to the given path, clobbering the existing
hui shang088a09a2019-09-11 21:26:49 +08001357 destination if it exists, and return a new Path instance
1358 pointing to the given path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001359 """
1360 if self._closed:
1361 self._raise_closed()
1362 self._accessor.replace(self, target)
hui shang088a09a2019-09-11 21:26:49 +08001363 return self.__class__(target)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001364
1365 def symlink_to(self, target, target_is_directory=False):
1366 """
1367 Make this path a symlink pointing to the given path.
1368 Note the order of arguments (self, target) is the reverse of os.symlink's.
1369 """
1370 if self._closed:
1371 self._raise_closed()
1372 self._accessor.symlink(target, self, target_is_directory)
1373
1374 # Convenience functions for querying the stat results
1375
1376 def exists(self):
1377 """
1378 Whether this path exists.
1379 """
1380 try:
1381 self.stat()
1382 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001383 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001384 raise
1385 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001386 except ValueError:
1387 # Non-encodable path
1388 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001389 return True
1390
1391 def is_dir(self):
1392 """
1393 Whether this path is a directory.
1394 """
1395 try:
1396 return S_ISDIR(self.stat().st_mode)
1397 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001398 if not _ignore_error(e):
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
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001403 except ValueError:
1404 # Non-encodable path
1405 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001406
1407 def is_file(self):
1408 """
1409 Whether this path is a regular file (also True for symlinks pointing
1410 to regular files).
1411 """
1412 try:
1413 return S_ISREG(self.stat().st_mode)
1414 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001415 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001416 raise
1417 # Path doesn't exist or is a broken symlink
1418 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1419 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001420 except ValueError:
1421 # Non-encodable path
1422 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001423
Cooper Lees173ff4a2017-08-01 15:35:45 -07001424 def is_mount(self):
1425 """
1426 Check if this path is a POSIX mount point
1427 """
1428 # Need to exist and be a dir
1429 if not self.exists() or not self.is_dir():
1430 return False
1431
1432 parent = Path(self.parent)
1433 try:
1434 parent_dev = parent.stat().st_dev
1435 except OSError:
1436 return False
1437
1438 dev = self.stat().st_dev
1439 if dev != parent_dev:
1440 return True
1441 ino = self.stat().st_ino
1442 parent_ino = parent.stat().st_ino
1443 return ino == parent_ino
1444
Antoine Pitrou31119e42013-11-22 17:38:12 +01001445 def is_symlink(self):
1446 """
1447 Whether this path is a symbolic link.
1448 """
1449 try:
1450 return S_ISLNK(self.lstat().st_mode)
1451 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001452 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001453 raise
1454 # Path doesn't exist
1455 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001456 except ValueError:
1457 # Non-encodable path
1458 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001459
1460 def is_block_device(self):
1461 """
1462 Whether this path is a block device.
1463 """
1464 try:
1465 return S_ISBLK(self.stat().st_mode)
1466 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001467 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001468 raise
1469 # Path doesn't exist or is a broken symlink
1470 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1471 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001472 except ValueError:
1473 # Non-encodable path
1474 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001475
1476 def is_char_device(self):
1477 """
1478 Whether this path is a character device.
1479 """
1480 try:
1481 return S_ISCHR(self.stat().st_mode)
1482 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001483 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001484 raise
1485 # Path doesn't exist or is a broken symlink
1486 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1487 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001488 except ValueError:
1489 # Non-encodable path
1490 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001491
1492 def is_fifo(self):
1493 """
1494 Whether this path is a FIFO.
1495 """
1496 try:
1497 return S_ISFIFO(self.stat().st_mode)
1498 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001499 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001500 raise
1501 # Path doesn't exist or is a broken symlink
1502 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1503 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001504 except ValueError:
1505 # Non-encodable path
1506 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001507
1508 def is_socket(self):
1509 """
1510 Whether this path is a socket.
1511 """
1512 try:
1513 return S_ISSOCK(self.stat().st_mode)
1514 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001515 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001516 raise
1517 # Path doesn't exist or is a broken symlink
1518 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1519 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001520 except ValueError:
1521 # Non-encodable path
1522 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001523
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001524 def expanduser(self):
1525 """ Return a new path with expanded ~ and ~user constructs
1526 (as returned by os.path.expanduser)
1527 """
1528 if (not (self._drv or self._root) and
1529 self._parts and self._parts[0][:1] == '~'):
1530 homedir = self._flavour.gethomedir(self._parts[0][1:])
1531 return self._from_parts([homedir] + self._parts[1:])
1532
1533 return self
1534
Antoine Pitrou31119e42013-11-22 17:38:12 +01001535
1536class PosixPath(Path, PurePosixPath):
chasondfa015c2018-02-19 08:36:32 +09001537 """Path subclass for non-Windows systems.
1538
1539 On a POSIX system, instantiating a Path should return this object.
1540 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001541 __slots__ = ()
1542
1543class WindowsPath(Path, PureWindowsPath):
chasondfa015c2018-02-19 08:36:32 +09001544 """Path subclass for Windows systems.
1545
1546 On a Windows system, instantiating a Path should return this object.
1547 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001548 __slots__ = ()
Berker Peksag04d42292016-03-11 23:07:27 +02001549
1550 def owner(self):
1551 raise NotImplementedError("Path.owner() is unsupported on this system")
1552
1553 def group(self):
1554 raise NotImplementedError("Path.group() is unsupported on this system")
Cooper Lees173ff4a2017-08-01 15:35:45 -07001555
1556 def is_mount(self):
1557 raise NotImplementedError("Path.is_mount() is unsupported on this system")