blob: d188026bcde840b6f035f859b16a2e73f94f0101 [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
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700190 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):
Miss Islington (bot)595b5162020-01-28 01:59:43 -0800256 if 'USERPROFILE' in os.environ:
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100257 userhome = os.environ['USERPROFILE']
258 elif 'HOMEPATH' in os.environ:
Antoine Pitrou5d4e27e2014-12-30 22:09:42 +0100259 try:
260 drv = os.environ['HOMEDRIVE']
261 except KeyError:
262 drv = ''
263 userhome = drv + os.environ['HOMEPATH']
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100264 else:
265 raise RuntimeError("Can't determine home directory")
266
267 if username:
268 # Try to guess user home directory. By default all users
269 # directories are located in the same place and are named by
270 # corresponding usernames. If current user home directory points
271 # to nonstandard place, this guess is likely wrong.
272 if os.environ['USERNAME'] != username:
273 drv, root, parts = self.parse_parts((userhome,))
274 if parts[-1] != os.environ['USERNAME']:
275 raise RuntimeError("Can't determine home directory "
276 "for %r" % username)
277 parts[-1] = username
278 if drv or root:
279 userhome = drv + root + self.join(parts[1:])
280 else:
281 userhome = self.join(parts)
282 return userhome
Antoine Pitrou31119e42013-11-22 17:38:12 +0100283
284class _PosixFlavour(_Flavour):
285 sep = '/'
286 altsep = ''
287 has_drv = False
288 pathmod = posixpath
289
290 is_supported = (os.name != 'nt')
291
292 def splitroot(self, part, sep=sep):
293 if part and part[0] == sep:
294 stripped_part = part.lstrip(sep)
295 # According to POSIX path resolution:
296 # http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11
297 # "A pathname that begins with two successive slashes may be
298 # interpreted in an implementation-defined manner, although more
299 # than two leading slashes shall be treated as a single slash".
300 if len(part) - len(stripped_part) == 2:
301 return '', sep * 2, stripped_part
302 else:
303 return '', sep, stripped_part
304 else:
305 return '', '', part
306
307 def casefold(self, s):
308 return s
309
310 def casefold_parts(self, parts):
311 return parts
312
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700313 def compile_pattern(self, pattern):
314 return re.compile(fnmatch.translate(pattern)).fullmatch
315
Steve Dower98eb3602016-11-09 12:58:17 -0800316 def resolve(self, path, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100317 sep = self.sep
Antoine Pitrou31119e42013-11-22 17:38:12 +0100318 accessor = path._accessor
Antoine Pitrouc274fd22013-12-16 19:57:41 +0100319 seen = {}
320 def _resolve(path, rest):
321 if rest.startswith(sep):
322 path = ''
323
324 for name in rest.split(sep):
325 if not name or name == '.':
326 # current dir
327 continue
328 if name == '..':
329 # parent dir
330 path, _, _ = path.rpartition(sep)
331 continue
332 newpath = path + sep + name
333 if newpath in seen:
334 # Already seen this path
335 path = seen[newpath]
336 if path is not None:
337 # use cached value
338 continue
339 # The symlink is not resolved, so we must have a symlink loop.
340 raise RuntimeError("Symlink loop from %r" % newpath)
341 # Resolve the symbolic link
342 try:
343 target = accessor.readlink(newpath)
344 except OSError as e:
Antoine Pietriadd98eb2017-06-07 17:29:17 +0200345 if e.errno != EINVAL and strict:
346 raise
347 # Not a symlink, or non-strict mode. We just leave the path
348 # untouched.
Antoine Pitrouc274fd22013-12-16 19:57:41 +0100349 path = newpath
350 else:
351 seen[newpath] = None # not resolved symlink
352 path = _resolve(path, target)
353 seen[newpath] = path # resolved symlink
354
355 return path
356 # NOTE: according to POSIX, getcwd() cannot contain path components
357 # which are symlinks.
358 base = '' if path.is_absolute() else os.getcwd()
359 return _resolve(base, str(path)) or sep
Antoine Pitrou31119e42013-11-22 17:38:12 +0100360
361 def is_reserved(self, parts):
362 return False
363
364 def make_uri(self, path):
365 # We represent the path using the local filesystem encoding,
366 # for portability to other applications.
367 bpath = bytes(path)
368 return 'file://' + urlquote_from_bytes(bpath)
369
Antoine Pitrou8477ed62014-12-30 20:54:45 +0100370 def gethomedir(self, username):
371 if not username:
372 try:
373 return os.environ['HOME']
374 except KeyError:
375 import pwd
376 return pwd.getpwuid(os.getuid()).pw_dir
377 else:
378 import pwd
379 try:
380 return pwd.getpwnam(username).pw_dir
381 except KeyError:
382 raise RuntimeError("Can't determine home directory "
383 "for %r" % username)
384
Antoine Pitrou31119e42013-11-22 17:38:12 +0100385
386_windows_flavour = _WindowsFlavour()
387_posix_flavour = _PosixFlavour()
388
389
390class _Accessor:
391 """An accessor implements a particular (system-specific or not) way of
392 accessing paths on the filesystem."""
393
394
395class _NormalAccessor(_Accessor):
396
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200397 stat = os.stat
Antoine Pitrou31119e42013-11-22 17:38:12 +0100398
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200399 lstat = os.lstat
Antoine Pitrou31119e42013-11-22 17:38:12 +0100400
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200401 open = os.open
Antoine Pitrou31119e42013-11-22 17:38:12 +0100402
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200403 listdir = os.listdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100404
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200405 scandir = os.scandir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100406
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200407 chmod = os.chmod
Antoine Pitrou31119e42013-11-22 17:38:12 +0100408
409 if hasattr(os, "lchmod"):
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200410 lchmod = os.lchmod
Antoine Pitrou31119e42013-11-22 17:38:12 +0100411 else:
412 def lchmod(self, pathobj, mode):
413 raise NotImplementedError("lchmod() not available on this system")
414
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200415 mkdir = os.mkdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100416
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200417 unlink = os.unlink
Antoine Pitrou31119e42013-11-22 17:38:12 +0100418
Miss Islington (bot)8d0f3692019-12-16 04:42:20 -0800419 if hasattr(os, "link"):
420 link_to = os.link
421 else:
422 @staticmethod
423 def link_to(self, target):
424 raise NotImplementedError("os.link() not available on this system")
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -0400425
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200426 rmdir = os.rmdir
Antoine Pitrou31119e42013-11-22 17:38:12 +0100427
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200428 rename = os.rename
Antoine Pitrou31119e42013-11-22 17:38:12 +0100429
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200430 replace = os.replace
Antoine Pitrou31119e42013-11-22 17:38:12 +0100431
432 if nt:
433 if supports_symlinks:
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200434 symlink = os.symlink
Antoine Pitrou31119e42013-11-22 17:38:12 +0100435 else:
436 def symlink(a, b, target_is_directory):
437 raise NotImplementedError("symlink() not available on this system")
438 else:
439 # Under POSIX, os.symlink() takes two args
440 @staticmethod
441 def symlink(a, b, target_is_directory):
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200442 return os.symlink(a, b)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100443
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200444 utime = os.utime
Antoine Pitrou31119e42013-11-22 17:38:12 +0100445
446 # Helper for resolve()
447 def readlink(self, path):
448 return os.readlink(path)
449
450
451_normal_accessor = _NormalAccessor()
452
453
454#
455# Globbing helpers
456#
457
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700458def _make_selector(pattern_parts, flavour):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100459 pat = pattern_parts[0]
460 child_parts = pattern_parts[1:]
461 if pat == '**':
462 cls = _RecursiveWildcardSelector
463 elif '**' in pat:
464 raise ValueError("Invalid pattern: '**' can only be an entire path component")
465 elif _is_wildcard_pattern(pat):
466 cls = _WildcardSelector
467 else:
468 cls = _PreciseSelector
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700469 return cls(pat, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100470
471if hasattr(functools, "lru_cache"):
472 _make_selector = functools.lru_cache()(_make_selector)
473
474
475class _Selector:
476 """A selector matches a specific glob pattern part against the children
477 of a given path."""
478
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700479 def __init__(self, child_parts, flavour):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100480 self.child_parts = child_parts
481 if child_parts:
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700482 self.successor = _make_selector(child_parts, flavour)
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300483 self.dironly = True
Antoine Pitrou31119e42013-11-22 17:38:12 +0100484 else:
485 self.successor = _TerminatingSelector()
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300486 self.dironly = False
Antoine Pitrou31119e42013-11-22 17:38:12 +0100487
488 def select_from(self, parent_path):
489 """Iterate over all child paths of `parent_path` matched by this
490 selector. This can contain parent_path itself."""
491 path_cls = type(parent_path)
492 is_dir = path_cls.is_dir
493 exists = path_cls.exists
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300494 scandir = parent_path._accessor.scandir
495 if not is_dir(parent_path):
496 return iter([])
497 return self._select_from(parent_path, is_dir, exists, scandir)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100498
499
500class _TerminatingSelector:
501
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300502 def _select_from(self, parent_path, is_dir, exists, scandir):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100503 yield parent_path
504
505
506class _PreciseSelector(_Selector):
507
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700508 def __init__(self, name, child_parts, flavour):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100509 self.name = name
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700510 _Selector.__init__(self, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100511
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300512 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800513 try:
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800514 path = parent_path._make_child_relpath(self.name)
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300515 if (is_dir if self.dironly else exists)(path):
516 for p in self.successor._select_from(path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800517 yield p
518 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100519 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100520
521
522class _WildcardSelector(_Selector):
523
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700524 def __init__(self, pat, child_parts, flavour):
525 self.match = flavour.compile_pattern(pat)
526 _Selector.__init__(self, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100527
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300528 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800529 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300530 entries = list(scandir(parent_path))
531 for entry in entries:
Miss Islington (bot)928b4dd2020-03-07 10:11:24 -0800532 if self.dironly:
533 try:
534 # "entry.is_dir()" can raise PermissionError
535 # in some cases (see bpo-38894), which is not
536 # among the errors ignored by _ignore_error()
537 if not entry.is_dir():
538 continue
539 except OSError as e:
540 if not _ignore_error(e):
541 raise
542 continue
543 name = entry.name
544 if self.match(name):
545 path = parent_path._make_child_relpath(name)
546 for p in self.successor._select_from(path, is_dir, exists, scandir):
547 yield p
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800548 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100549 return
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800550
Antoine Pitrou31119e42013-11-22 17:38:12 +0100551
Antoine Pitrou31119e42013-11-22 17:38:12 +0100552class _RecursiveWildcardSelector(_Selector):
553
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -0700554 def __init__(self, pat, child_parts, flavour):
555 _Selector.__init__(self, child_parts, flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100556
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300557 def _iterate_directories(self, parent_path, is_dir, scandir):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100558 yield parent_path
Guido van Rossumbc9fdda2016-01-07 10:56:36 -0800559 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300560 entries = list(scandir(parent_path))
561 for entry in entries:
Przemysław Spodymek216b7452018-08-27 23:33:45 +0200562 entry_is_dir = False
563 try:
564 entry_is_dir = entry.is_dir()
565 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -0800566 if not _ignore_error(e):
Przemysław Spodymek216b7452018-08-27 23:33:45 +0200567 raise
568 if entry_is_dir and not entry.is_symlink():
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300569 path = parent_path._make_child_relpath(entry.name)
570 for p in self._iterate_directories(path, is_dir, scandir):
Guido van Rossumbc9fdda2016-01-07 10:56:36 -0800571 yield p
572 except PermissionError:
573 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100574
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300575 def _select_from(self, parent_path, is_dir, exists, scandir):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800576 try:
Serhiy Storchaka680cb152016-09-07 10:58:05 +0300577 yielded = set()
578 try:
579 successor_select = self.successor._select_from
580 for starting_point in self._iterate_directories(parent_path, is_dir, scandir):
581 for p in successor_select(starting_point, is_dir, exists, scandir):
582 if p not in yielded:
583 yield p
584 yielded.add(p)
585 finally:
586 yielded.clear()
Guido van Rossum6c2d33a2016-01-06 09:42:07 -0800587 except PermissionError:
Antoine Pitrou31119e42013-11-22 17:38:12 +0100588 return
Antoine Pitrou31119e42013-11-22 17:38:12 +0100589
590
591#
592# Public API
593#
594
595class _PathParents(Sequence):
596 """This object provides sequence-like access to the logical ancestors
597 of a path. Don't try to construct it yourself."""
598 __slots__ = ('_pathcls', '_drv', '_root', '_parts')
599
600 def __init__(self, path):
601 # We don't store the instance to avoid reference cycles
602 self._pathcls = type(path)
603 self._drv = path._drv
604 self._root = path._root
605 self._parts = path._parts
606
607 def __len__(self):
608 if self._drv or self._root:
609 return len(self._parts) - 1
610 else:
611 return len(self._parts)
612
613 def __getitem__(self, idx):
614 if idx < 0 or idx >= len(self):
615 raise IndexError(idx)
616 return self._pathcls._from_parsed_parts(self._drv, self._root,
617 self._parts[:-idx - 1])
618
619 def __repr__(self):
620 return "<{}.parents>".format(self._pathcls.__name__)
621
622
623class PurePath(object):
chasondfa015c2018-02-19 08:36:32 +0900624 """Base class for manipulating paths without I/O.
625
626 PurePath represents a filesystem path and offers operations which
Antoine Pitrou31119e42013-11-22 17:38:12 +0100627 don't imply any actual filesystem I/O. Depending on your system,
628 instantiating a PurePath will return either a PurePosixPath or a
629 PureWindowsPath object. You can also instantiate either of these classes
630 directly, regardless of your system.
631 """
632 __slots__ = (
633 '_drv', '_root', '_parts',
634 '_str', '_hash', '_pparts', '_cached_cparts',
635 )
636
637 def __new__(cls, *args):
638 """Construct a PurePath from one or several strings and or existing
639 PurePath objects. The strings and path objects are combined so as
640 to yield a canonicalized path, which is incorporated into the
641 new PurePath object.
642 """
643 if cls is PurePath:
644 cls = PureWindowsPath if os.name == 'nt' else PurePosixPath
645 return cls._from_parts(args)
646
647 def __reduce__(self):
648 # Using the parts tuple helps share interned path parts
649 # when pickling related paths.
650 return (self.__class__, tuple(self._parts))
651
652 @classmethod
653 def _parse_args(cls, args):
654 # This is useful when you don't want to create an instance, just
655 # canonicalize some constructor arguments.
656 parts = []
657 for a in args:
658 if isinstance(a, PurePath):
659 parts += a._parts
Antoine Pitrou31119e42013-11-22 17:38:12 +0100660 else:
Brett Cannon568be632016-06-10 12:20:49 -0700661 a = os.fspath(a)
662 if isinstance(a, str):
663 # Force-cast str subclasses to str (issue #21127)
664 parts.append(str(a))
665 else:
666 raise TypeError(
667 "argument should be a str object or an os.PathLike "
668 "object returning str, not %r"
669 % type(a))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100670 return cls._flavour.parse_parts(parts)
671
672 @classmethod
673 def _from_parts(cls, args, init=True):
674 # We need to call _parse_args on the instance, so as to get the
675 # right flavour.
676 self = object.__new__(cls)
677 drv, root, parts = self._parse_args(args)
678 self._drv = drv
679 self._root = root
680 self._parts = parts
681 if init:
682 self._init()
683 return self
684
685 @classmethod
686 def _from_parsed_parts(cls, drv, root, parts, init=True):
687 self = object.__new__(cls)
688 self._drv = drv
689 self._root = root
690 self._parts = parts
691 if init:
692 self._init()
693 return self
694
695 @classmethod
696 def _format_parsed_parts(cls, drv, root, parts):
697 if drv or root:
698 return drv + root + cls._flavour.join(parts[1:])
699 else:
700 return cls._flavour.join(parts)
701
702 def _init(self):
Martin Pantere26da7c2016-06-02 10:07:09 +0000703 # Overridden in concrete Path
Antoine Pitrou31119e42013-11-22 17:38:12 +0100704 pass
705
706 def _make_child(self, args):
707 drv, root, parts = self._parse_args(args)
708 drv, root, parts = self._flavour.join_parsed_parts(
709 self._drv, self._root, self._parts, drv, root, parts)
710 return self._from_parsed_parts(drv, root, parts)
711
712 def __str__(self):
713 """Return the string representation of the path, suitable for
714 passing to system calls."""
715 try:
716 return self._str
717 except AttributeError:
718 self._str = self._format_parsed_parts(self._drv, self._root,
719 self._parts) or '.'
720 return self._str
721
Brett Cannon568be632016-06-10 12:20:49 -0700722 def __fspath__(self):
723 return str(self)
724
Antoine Pitrou31119e42013-11-22 17:38:12 +0100725 def as_posix(self):
726 """Return the string representation of the path with forward (/)
727 slashes."""
728 f = self._flavour
729 return str(self).replace(f.sep, '/')
730
731 def __bytes__(self):
732 """Return the bytes representation of the path. This is only
733 recommended to use under Unix."""
Serhiy Storchaka62a99512017-03-25 13:42:11 +0200734 return os.fsencode(self)
Antoine Pitrou31119e42013-11-22 17:38:12 +0100735
736 def __repr__(self):
737 return "{}({!r})".format(self.__class__.__name__, self.as_posix())
738
739 def as_uri(self):
740 """Return the path as a 'file' URI."""
741 if not self.is_absolute():
742 raise ValueError("relative path can't be expressed as a file URI")
743 return self._flavour.make_uri(self)
744
745 @property
746 def _cparts(self):
747 # Cached casefolded parts, for hashing and comparison
748 try:
749 return self._cached_cparts
750 except AttributeError:
751 self._cached_cparts = self._flavour.casefold_parts(self._parts)
752 return self._cached_cparts
753
754 def __eq__(self, other):
755 if not isinstance(other, PurePath):
756 return NotImplemented
757 return self._cparts == other._cparts and self._flavour is other._flavour
758
Antoine Pitrou31119e42013-11-22 17:38:12 +0100759 def __hash__(self):
760 try:
761 return self._hash
762 except AttributeError:
763 self._hash = hash(tuple(self._cparts))
764 return self._hash
765
766 def __lt__(self, other):
767 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
768 return NotImplemented
769 return self._cparts < other._cparts
770
771 def __le__(self, other):
772 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
773 return NotImplemented
774 return self._cparts <= other._cparts
775
776 def __gt__(self, other):
777 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
778 return NotImplemented
779 return self._cparts > other._cparts
780
781 def __ge__(self, other):
782 if not isinstance(other, PurePath) or self._flavour is not other._flavour:
783 return NotImplemented
784 return self._cparts >= other._cparts
785
786 drive = property(attrgetter('_drv'),
787 doc="""The drive prefix (letter or UNC path), if any.""")
788
789 root = property(attrgetter('_root'),
790 doc="""The root of the path, if any.""")
791
792 @property
793 def anchor(self):
794 """The concatenation of the drive and root, or ''."""
795 anchor = self._drv + self._root
796 return anchor
797
798 @property
799 def name(self):
800 """The final path component, if any."""
801 parts = self._parts
802 if len(parts) == (1 if (self._drv or self._root) else 0):
803 return ''
804 return parts[-1]
805
806 @property
807 def suffix(self):
Miss Skeleton (bot)aa1fee82019-11-02 10:04:10 -0700808 """
809 The final component's last suffix, if any.
810
811 This includes the leading period. For example: '.txt'
812 """
Antoine Pitrou31119e42013-11-22 17:38:12 +0100813 name = self.name
814 i = name.rfind('.')
815 if 0 < i < len(name) - 1:
816 return name[i:]
817 else:
818 return ''
819
820 @property
821 def suffixes(self):
Miss Skeleton (bot)aa1fee82019-11-02 10:04:10 -0700822 """
823 A list of the final component's suffixes, if any.
824
825 These include the leading periods. For example: ['.tar', '.gz']
826 """
Antoine Pitrou31119e42013-11-22 17:38:12 +0100827 name = self.name
828 if name.endswith('.'):
829 return []
830 name = name.lstrip('.')
831 return ['.' + suffix for suffix in name.split('.')[1:]]
832
833 @property
834 def stem(self):
835 """The final path component, minus its last suffix."""
836 name = self.name
837 i = name.rfind('.')
838 if 0 < i < len(name) - 1:
839 return name[:i]
840 else:
841 return name
842
843 def with_name(self, name):
844 """Return a new path with the file name changed."""
845 if not self.name:
846 raise ValueError("%r has an empty name" % (self,))
Antoine Pitrou7084e732014-07-06 21:31:12 -0400847 drv, root, parts = self._flavour.parse_parts((name,))
848 if (not name or name[-1] in [self._flavour.sep, self._flavour.altsep]
849 or drv or root or len(parts) != 1):
850 raise ValueError("Invalid name %r" % (name))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100851 return self._from_parsed_parts(self._drv, self._root,
852 self._parts[:-1] + [name])
853
854 def with_suffix(self, suffix):
Stefan Otte46dc4e32018-08-03 22:49:42 +0200855 """Return a new path with the file suffix changed. If the path
856 has no suffix, add given suffix. If the given suffix is an empty
857 string, remove the suffix from the path.
858 """
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400859 f = self._flavour
860 if f.sep in suffix or f.altsep and f.altsep in suffix:
Berker Peksag423d05f2018-08-11 08:45:06 +0300861 raise ValueError("Invalid suffix %r" % (suffix,))
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400862 if suffix and not suffix.startswith('.') or suffix == '.':
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100863 raise ValueError("Invalid suffix %r" % (suffix))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100864 name = self.name
865 if not name:
866 raise ValueError("%r has an empty name" % (self,))
867 old_suffix = self.suffix
868 if not old_suffix:
869 name = name + suffix
870 else:
871 name = name[:-len(old_suffix)] + suffix
872 return self._from_parsed_parts(self._drv, self._root,
873 self._parts[:-1] + [name])
874
875 def relative_to(self, *other):
876 """Return the relative path to another path identified by the passed
877 arguments. If the operation is not possible (because this is not
878 a subpath of the other path), raise ValueError.
879 """
880 # For the purpose of this method, drive and root are considered
881 # separate parts, i.e.:
882 # Path('c:/').relative_to('c:') gives Path('/')
883 # Path('c:/').relative_to('/') raise ValueError
884 if not other:
885 raise TypeError("need at least one argument")
886 parts = self._parts
887 drv = self._drv
888 root = self._root
Antoine Pitrou156b3612013-12-28 19:49:04 +0100889 if root:
890 abs_parts = [drv, root] + parts[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100891 else:
892 abs_parts = parts
893 to_drv, to_root, to_parts = self._parse_args(other)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100894 if to_root:
895 to_abs_parts = [to_drv, to_root] + to_parts[1:]
Antoine Pitrou31119e42013-11-22 17:38:12 +0100896 else:
897 to_abs_parts = to_parts
898 n = len(to_abs_parts)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100899 cf = self._flavour.casefold_parts
900 if (root or drv) if n == 0 else cf(abs_parts[:n]) != cf(to_abs_parts):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100901 formatted = self._format_parsed_parts(to_drv, to_root, to_parts)
902 raise ValueError("{!r} does not start with {!r}"
903 .format(str(self), str(formatted)))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100904 return self._from_parsed_parts('', root if n == 1 else '',
905 abs_parts[n:])
Antoine Pitrou31119e42013-11-22 17:38:12 +0100906
907 @property
908 def parts(self):
909 """An object providing sequence-like access to the
910 components in the filesystem path."""
911 # We cache the tuple to avoid building a new one each time .parts
912 # is accessed. XXX is this necessary?
913 try:
914 return self._pparts
915 except AttributeError:
916 self._pparts = tuple(self._parts)
917 return self._pparts
918
919 def joinpath(self, *args):
920 """Combine this path with one or several arguments, and return a
921 new path representing either a subpath (if all arguments are relative
922 paths) or a totally different path (if one of the arguments is
923 anchored).
924 """
925 return self._make_child(args)
926
927 def __truediv__(self, key):
Miss Islington (bot)4adcaf82019-08-28 22:05:59 -0700928 try:
929 return self._make_child((key,))
930 except TypeError:
931 return NotImplemented
Antoine Pitrou31119e42013-11-22 17:38:12 +0100932
933 def __rtruediv__(self, key):
Miss Islington (bot)4adcaf82019-08-28 22:05:59 -0700934 try:
935 return self._from_parts([key] + self._parts)
936 except TypeError:
937 return NotImplemented
Antoine Pitrou31119e42013-11-22 17:38:12 +0100938
939 @property
940 def parent(self):
941 """The logical parent of the path."""
942 drv = self._drv
943 root = self._root
944 parts = self._parts
945 if len(parts) == 1 and (drv or root):
946 return self
947 return self._from_parsed_parts(drv, root, parts[:-1])
948
949 @property
950 def parents(self):
951 """A sequence of this path's logical parents."""
952 return _PathParents(self)
953
954 def is_absolute(self):
955 """True if the path is absolute (has both a root and, if applicable,
956 a drive)."""
957 if not self._root:
958 return False
959 return not self._flavour.has_drv or bool(self._drv)
960
961 def is_reserved(self):
962 """Return True if the path contains one of the special names reserved
963 by the system, if any."""
964 return self._flavour.is_reserved(self._parts)
965
966 def match(self, path_pattern):
967 """
968 Return True if this path matches the given pattern.
969 """
970 cf = self._flavour.casefold
971 path_pattern = cf(path_pattern)
972 drv, root, pat_parts = self._flavour.parse_parts((path_pattern,))
973 if not pat_parts:
974 raise ValueError("empty pattern")
975 if drv and drv != cf(self._drv):
976 return False
977 if root and root != cf(self._root):
978 return False
979 parts = self._cparts
980 if drv or root:
981 if len(pat_parts) != len(parts):
982 return False
983 pat_parts = pat_parts[1:]
984 elif len(pat_parts) > len(parts):
985 return False
986 for part, pat in zip(reversed(parts), reversed(pat_parts)):
987 if not fnmatch.fnmatchcase(part, pat):
988 return False
989 return True
990
Brett Cannon568be632016-06-10 12:20:49 -0700991# Can't subclass os.PathLike from PurePath and keep the constructor
992# optimizations in PurePath._parse_args().
993os.PathLike.register(PurePath)
994
Antoine Pitrou31119e42013-11-22 17:38:12 +0100995
996class PurePosixPath(PurePath):
chasondfa015c2018-02-19 08:36:32 +0900997 """PurePath subclass for non-Windows systems.
998
999 On a POSIX system, instantiating a PurePath should return this object.
1000 However, you can also instantiate it directly on any system.
1001 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001002 _flavour = _posix_flavour
1003 __slots__ = ()
1004
1005
1006class PureWindowsPath(PurePath):
chasondfa015c2018-02-19 08:36:32 +09001007 """PurePath subclass for Windows systems.
1008
1009 On a Windows system, instantiating a PurePath should return this object.
1010 However, you can also instantiate it directly on any system.
1011 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001012 _flavour = _windows_flavour
1013 __slots__ = ()
1014
1015
1016# Filesystem-accessing classes
1017
1018
1019class Path(PurePath):
chasondfa015c2018-02-19 08:36:32 +09001020 """PurePath subclass that can make system calls.
1021
1022 Path represents a filesystem path but unlike PurePath, also offers
1023 methods to do system calls on path objects. Depending on your system,
1024 instantiating a Path will return either a PosixPath or a WindowsPath
1025 object. You can also instantiate a PosixPath or WindowsPath directly,
1026 but cannot instantiate a WindowsPath on a POSIX system or vice versa.
1027 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001028 __slots__ = (
1029 '_accessor',
1030 '_closed',
1031 )
1032
1033 def __new__(cls, *args, **kwargs):
1034 if cls is Path:
1035 cls = WindowsPath if os.name == 'nt' else PosixPath
1036 self = cls._from_parts(args, init=False)
1037 if not self._flavour.is_supported:
1038 raise NotImplementedError("cannot instantiate %r on your system"
1039 % (cls.__name__,))
1040 self._init()
1041 return self
1042
1043 def _init(self,
1044 # Private non-constructor arguments
1045 template=None,
1046 ):
1047 self._closed = False
1048 if template is not None:
1049 self._accessor = template._accessor
1050 else:
1051 self._accessor = _normal_accessor
1052
1053 def _make_child_relpath(self, part):
1054 # This is an optimization used for dir walking. `part` must be
1055 # a single part relative to this path.
1056 parts = self._parts + [part]
1057 return self._from_parsed_parts(self._drv, self._root, parts)
1058
1059 def __enter__(self):
1060 if self._closed:
1061 self._raise_closed()
1062 return self
1063
1064 def __exit__(self, t, v, tb):
1065 self._closed = True
1066
1067 def _raise_closed(self):
1068 raise ValueError("I/O operation on closed path")
1069
1070 def _opener(self, name, flags, mode=0o666):
1071 # A stub for the opener argument to built-in open()
1072 return self._accessor.open(self, flags, mode)
1073
Antoine Pitrou4a60d422013-12-02 21:25:18 +01001074 def _raw_open(self, flags, mode=0o777):
1075 """
1076 Open the file pointed by this path and return a file descriptor,
1077 as os.open() does.
1078 """
1079 if self._closed:
1080 self._raise_closed()
1081 return self._accessor.open(self, flags, mode)
1082
Antoine Pitrou31119e42013-11-22 17:38:12 +01001083 # Public API
1084
1085 @classmethod
1086 def cwd(cls):
1087 """Return a new path pointing to the current working directory
1088 (as returned by os.getcwd()).
1089 """
1090 return cls(os.getcwd())
1091
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001092 @classmethod
1093 def home(cls):
1094 """Return a new path pointing to the user's home directory (as
1095 returned by os.path.expanduser('~')).
1096 """
1097 return cls(cls()._flavour.gethomedir(None))
1098
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001099 def samefile(self, other_path):
Berker Peksag05492b82015-10-22 03:34:16 +03001100 """Return whether other_path is the same or not as this file
Berker Peksag267597f2015-10-21 20:10:24 +03001101 (as returned by os.path.samefile()).
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001102 """
1103 st = self.stat()
1104 try:
1105 other_st = other_path.stat()
1106 except AttributeError:
1107 other_st = os.stat(other_path)
1108 return os.path.samestat(st, other_st)
1109
Antoine Pitrou31119e42013-11-22 17:38:12 +01001110 def iterdir(self):
1111 """Iterate over the files in this directory. Does not yield any
1112 result for the special paths '.' and '..'.
1113 """
1114 if self._closed:
1115 self._raise_closed()
1116 for name in self._accessor.listdir(self):
1117 if name in {'.', '..'}:
1118 # Yielding a path object for these makes little sense
1119 continue
1120 yield self._make_child_relpath(name)
1121 if self._closed:
1122 self._raise_closed()
1123
1124 def glob(self, pattern):
1125 """Iterate over this subtree and yield all existing files (of any
Eivind Teig537b6ca2019-02-11 11:47:09 +01001126 kind, including directories) matching the given relative pattern.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001127 """
Berker Peksag4a208e42016-01-30 17:50:48 +02001128 if not pattern:
1129 raise ValueError("Unacceptable pattern: {!r}".format(pattern))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001130 drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
1131 if drv or root:
1132 raise NotImplementedError("Non-relative patterns are unsupported")
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -07001133 selector = _make_selector(tuple(pattern_parts), self._flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001134 for p in selector.select_from(self):
1135 yield p
1136
1137 def rglob(self, pattern):
1138 """Recursively yield all existing files (of any kind, including
Eivind Teig537b6ca2019-02-11 11:47:09 +01001139 directories) matching the given relative pattern, anywhere in
1140 this subtree.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001141 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001142 drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
1143 if drv or root:
1144 raise NotImplementedError("Non-relative patterns are unsupported")
Miss Skeleton (bot)2f8d4f02019-10-21 11:17:57 -07001145 selector = _make_selector(("**",) + tuple(pattern_parts), self._flavour)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001146 for p in selector.select_from(self):
1147 yield p
1148
1149 def absolute(self):
1150 """Return an absolute version of this path. This function works
1151 even if the path doesn't point to anything.
1152
1153 No normalization is done, i.e. all '.' and '..' will be kept along.
1154 Use resolve() to get the canonical path to a file.
1155 """
1156 # XXX untested yet!
1157 if self._closed:
1158 self._raise_closed()
1159 if self.is_absolute():
1160 return self
1161 # FIXME this must defer to the specific flavour (and, under Windows,
1162 # use nt._getfullpathname())
1163 obj = self._from_parts([os.getcwd()] + self._parts, init=False)
1164 obj._init(template=self)
1165 return obj
1166
Steve Dower98eb3602016-11-09 12:58:17 -08001167 def resolve(self, strict=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001168 """
1169 Make the path absolute, resolving all symlinks on the way and also
1170 normalizing it (for example turning slashes into backslashes under
1171 Windows).
1172 """
1173 if self._closed:
1174 self._raise_closed()
Steve Dower98eb3602016-11-09 12:58:17 -08001175 s = self._flavour.resolve(self, strict=strict)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001176 if s is None:
1177 # No symlink resolution => for consistency, raise an error if
1178 # the path doesn't exist or is forbidden
1179 self.stat()
1180 s = str(self.absolute())
1181 # Now we have no symlinks in the path, it's safe to normalize it.
1182 normed = self._flavour.pathmod.normpath(s)
1183 obj = self._from_parts((normed,), init=False)
1184 obj._init(template=self)
1185 return obj
1186
1187 def stat(self):
1188 """
1189 Return the result of the stat() system call on this path, like
1190 os.stat() does.
1191 """
1192 return self._accessor.stat(self)
1193
1194 def owner(self):
1195 """
1196 Return the login name of the file owner.
1197 """
1198 import pwd
1199 return pwd.getpwuid(self.stat().st_uid).pw_name
1200
1201 def group(self):
1202 """
1203 Return the group name of the file gid.
1204 """
1205 import grp
1206 return grp.getgrgid(self.stat().st_gid).gr_name
1207
Antoine Pitrou31119e42013-11-22 17:38:12 +01001208 def open(self, mode='r', buffering=-1, encoding=None,
1209 errors=None, newline=None):
1210 """
1211 Open the file pointed by this path and return a file object, as
1212 the built-in open() function does.
1213 """
1214 if self._closed:
1215 self._raise_closed()
Serhiy Storchaka62a99512017-03-25 13:42:11 +02001216 return io.open(self, mode, buffering, encoding, errors, newline,
Antoine Pitrou31119e42013-11-22 17:38:12 +01001217 opener=self._opener)
1218
Georg Brandlea683982014-10-01 19:12:33 +02001219 def read_bytes(self):
1220 """
1221 Open the file in bytes mode, read it, and close the file.
1222 """
1223 with self.open(mode='rb') as f:
1224 return f.read()
1225
1226 def read_text(self, encoding=None, errors=None):
1227 """
1228 Open the file in text mode, read it, and close the file.
1229 """
1230 with self.open(mode='r', encoding=encoding, errors=errors) as f:
1231 return f.read()
1232
1233 def write_bytes(self, data):
1234 """
1235 Open the file in bytes mode, write to it, and close the file.
1236 """
1237 # type-check for the buffer interface before truncating the file
1238 view = memoryview(data)
1239 with self.open(mode='wb') as f:
1240 return f.write(view)
1241
1242 def write_text(self, data, encoding=None, errors=None):
1243 """
1244 Open the file in text mode, write to it, and close the file.
1245 """
1246 if not isinstance(data, str):
1247 raise TypeError('data must be str, not %s' %
1248 data.__class__.__name__)
1249 with self.open(mode='w', encoding=encoding, errors=errors) as f:
1250 return f.write(data)
1251
Antoine Pitrou31119e42013-11-22 17:38:12 +01001252 def touch(self, mode=0o666, exist_ok=True):
1253 """
1254 Create this file with the given access mode, if it doesn't exist.
1255 """
1256 if self._closed:
1257 self._raise_closed()
1258 if exist_ok:
1259 # First try to bump modification time
1260 # Implementation note: GNU touch uses the UTIME_NOW option of
1261 # the utimensat() / futimens() functions.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001262 try:
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001263 self._accessor.utime(self, None)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001264 except OSError:
1265 # Avoid exception chaining
1266 pass
1267 else:
1268 return
1269 flags = os.O_CREAT | os.O_WRONLY
1270 if not exist_ok:
1271 flags |= os.O_EXCL
1272 fd = self._raw_open(flags, mode)
1273 os.close(fd)
1274
Barry Warsaw7c549c42014-08-05 11:28:12 -04001275 def mkdir(self, mode=0o777, parents=False, exist_ok=False):
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001276 """
1277 Create a new directory at this given path.
1278 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001279 if self._closed:
1280 self._raise_closed()
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001281 try:
1282 self._accessor.mkdir(self, mode)
1283 except FileNotFoundError:
1284 if not parents or self.parent == self:
1285 raise
Armin Rigo22a594a2017-04-13 20:08:15 +02001286 self.parent.mkdir(parents=True, exist_ok=True)
1287 self.mkdir(mode, parents=False, exist_ok=exist_ok)
Serhiy Storchakaaf7b9ec2017-03-24 20:51:53 +02001288 except OSError:
1289 # Cannot rely on checking for EEXIST, since the operating system
1290 # could give priority to other errors like EACCES or EROFS
1291 if not exist_ok or not self.is_dir():
1292 raise
Antoine Pitrou31119e42013-11-22 17:38:12 +01001293
1294 def chmod(self, mode):
1295 """
1296 Change the permissions of the path, like os.chmod().
1297 """
1298 if self._closed:
1299 self._raise_closed()
1300 self._accessor.chmod(self, mode)
1301
1302 def lchmod(self, mode):
1303 """
1304 Like chmod(), except if the path points to a symlink, the symlink's
1305 permissions are changed, rather than its target's.
1306 """
1307 if self._closed:
1308 self._raise_closed()
1309 self._accessor.lchmod(self, mode)
1310
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001311 def unlink(self, missing_ok=False):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001312 """
1313 Remove this file or link.
1314 If the path is a directory, use rmdir() instead.
1315 """
1316 if self._closed:
1317 self._raise_closed()
‮zlohhcuB treboRd9e006b2019-05-16 00:02:11 +02001318 try:
1319 self._accessor.unlink(self)
1320 except FileNotFoundError:
1321 if not missing_ok:
1322 raise
Antoine Pitrou31119e42013-11-22 17:38:12 +01001323
1324 def rmdir(self):
1325 """
1326 Remove this directory. The directory must be empty.
1327 """
1328 if self._closed:
1329 self._raise_closed()
1330 self._accessor.rmdir(self)
1331
1332 def lstat(self):
1333 """
1334 Like stat(), except if the path points to a symlink, the symlink's
1335 status information is returned, rather than its target's.
1336 """
1337 if self._closed:
1338 self._raise_closed()
1339 return self._accessor.lstat(self)
1340
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001341 def link_to(self, target):
1342 """
1343 Create a hard link pointing to a path named target.
1344 """
1345 if self._closed:
1346 self._raise_closed()
1347 self._accessor.link_to(self, target)
1348
Antoine Pitrou31119e42013-11-22 17:38:12 +01001349 def rename(self, target):
1350 """
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001351 Rename this path to the given path,
1352 and return a new Path instance pointing to the given path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001353 """
1354 if self._closed:
1355 self._raise_closed()
1356 self._accessor.rename(self, target)
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001357 return self.__class__(target)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001358
1359 def replace(self, target):
1360 """
1361 Rename this path to the given path, clobbering the existing
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001362 destination if it exists, and return a new Path instance
1363 pointing to the given path.
Antoine Pitrou31119e42013-11-22 17:38:12 +01001364 """
1365 if self._closed:
1366 self._raise_closed()
1367 self._accessor.replace(self, target)
Miss Islington (bot)cbd7b2a2019-09-11 07:12:54 -07001368 return self.__class__(target)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001369
1370 def symlink_to(self, target, target_is_directory=False):
1371 """
1372 Make this path a symlink pointing to the given path.
1373 Note the order of arguments (self, target) is the reverse of os.symlink's.
1374 """
1375 if self._closed:
1376 self._raise_closed()
1377 self._accessor.symlink(target, self, target_is_directory)
1378
1379 # Convenience functions for querying the stat results
1380
1381 def exists(self):
1382 """
1383 Whether this path exists.
1384 """
1385 try:
1386 self.stat()
1387 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001388 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001389 raise
1390 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001391 except ValueError:
1392 # Non-encodable path
1393 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001394 return True
1395
1396 def is_dir(self):
1397 """
1398 Whether this path is a directory.
1399 """
1400 try:
1401 return S_ISDIR(self.stat().st_mode)
1402 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001403 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001404 raise
1405 # Path doesn't exist or is a broken symlink
1406 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1407 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001408 except ValueError:
1409 # Non-encodable path
1410 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001411
1412 def is_file(self):
1413 """
1414 Whether this path is a regular file (also True for symlinks pointing
1415 to regular files).
1416 """
1417 try:
1418 return S_ISREG(self.stat().st_mode)
1419 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001420 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001421 raise
1422 # Path doesn't exist or is a broken symlink
1423 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1424 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001425 except ValueError:
1426 # Non-encodable path
1427 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001428
Cooper Lees173ff4a2017-08-01 15:35:45 -07001429 def is_mount(self):
1430 """
1431 Check if this path is a POSIX mount point
1432 """
1433 # Need to exist and be a dir
1434 if not self.exists() or not self.is_dir():
1435 return False
1436
1437 parent = Path(self.parent)
1438 try:
1439 parent_dev = parent.stat().st_dev
1440 except OSError:
1441 return False
1442
1443 dev = self.stat().st_dev
1444 if dev != parent_dev:
1445 return True
1446 ino = self.stat().st_ino
1447 parent_ino = parent.stat().st_ino
1448 return ino == parent_ino
1449
Antoine Pitrou31119e42013-11-22 17:38:12 +01001450 def is_symlink(self):
1451 """
1452 Whether this path is a symbolic link.
1453 """
1454 try:
1455 return S_ISLNK(self.lstat().st_mode)
1456 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001457 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001458 raise
1459 # Path doesn't exist
1460 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001461 except ValueError:
1462 # Non-encodable path
1463 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001464
1465 def is_block_device(self):
1466 """
1467 Whether this path is a block device.
1468 """
1469 try:
1470 return S_ISBLK(self.stat().st_mode)
1471 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001472 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001473 raise
1474 # Path doesn't exist or is a broken symlink
1475 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1476 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001477 except ValueError:
1478 # Non-encodable path
1479 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001480
1481 def is_char_device(self):
1482 """
1483 Whether this path is a character device.
1484 """
1485 try:
1486 return S_ISCHR(self.stat().st_mode)
1487 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001488 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001489 raise
1490 # Path doesn't exist or is a broken symlink
1491 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1492 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001493 except ValueError:
1494 # Non-encodable path
1495 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001496
1497 def is_fifo(self):
1498 """
1499 Whether this path is a FIFO.
1500 """
1501 try:
1502 return S_ISFIFO(self.stat().st_mode)
1503 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001504 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001505 raise
1506 # Path doesn't exist or is a broken symlink
1507 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1508 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001509 except ValueError:
1510 # Non-encodable path
1511 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001512
1513 def is_socket(self):
1514 """
1515 Whether this path is a socket.
1516 """
1517 try:
1518 return S_ISSOCK(self.stat().st_mode)
1519 except OSError as e:
Steve Dower2f6fae62019-02-03 23:08:18 -08001520 if not _ignore_error(e):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001521 raise
1522 # Path doesn't exist or is a broken symlink
1523 # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
1524 return False
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001525 except ValueError:
1526 # Non-encodable path
1527 return False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001528
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001529 def expanduser(self):
1530 """ Return a new path with expanded ~ and ~user constructs
1531 (as returned by os.path.expanduser)
1532 """
1533 if (not (self._drv or self._root) and
1534 self._parts and self._parts[0][:1] == '~'):
1535 homedir = self._flavour.gethomedir(self._parts[0][1:])
1536 return self._from_parts([homedir] + self._parts[1:])
1537
1538 return self
1539
Antoine Pitrou31119e42013-11-22 17:38:12 +01001540
1541class PosixPath(Path, PurePosixPath):
chasondfa015c2018-02-19 08:36:32 +09001542 """Path subclass for non-Windows systems.
1543
1544 On a POSIX system, instantiating a Path should return this object.
1545 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001546 __slots__ = ()
1547
1548class WindowsPath(Path, PureWindowsPath):
chasondfa015c2018-02-19 08:36:32 +09001549 """Path subclass for Windows systems.
1550
1551 On a Windows system, instantiating a Path should return this object.
1552 """
Antoine Pitrou31119e42013-11-22 17:38:12 +01001553 __slots__ = ()
Berker Peksag04d42292016-03-11 23:07:27 +02001554
1555 def owner(self):
1556 raise NotImplementedError("Path.owner() is unsupported on this system")
1557
1558 def group(self):
1559 raise NotImplementedError("Path.group() is unsupported on this system")
Cooper Lees173ff4a2017-08-01 15:35:45 -07001560
1561 def is_mount(self):
1562 raise NotImplementedError("Path.is_mount() is unsupported on this system")