12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280 |
- import fnmatch
- import functools
- import io
- import ntpath
- import os
- import posixpath
- import re
- import sys
- import time
- from collections import Sequence
- from contextlib import contextmanager
- from errno import EINVAL, ENOENT
- from operator import attrgetter
- from stat import S_ISDIR, S_ISLNK, S_ISREG, S_ISSOCK, S_ISBLK, S_ISCHR, S_ISFIFO
- try:
- from urllib import quote as urlquote, quote as urlquote_from_bytes
- except ImportError:
- from urllib.parse import quote as urlquote, quote_from_bytes as urlquote_from_bytes
- try:
- intern = intern
- except NameError:
- intern = sys.intern
- try:
- basestring = basestring
- except NameError:
- basestring = str
- supports_symlinks = True
- try:
- import nt
- except ImportError:
- nt = None
- else:
- if sys.getwindowsversion()[:2] >= (6, 0) and sys.version_info >= (3, 2):
- from nt import _getfinalpathname
- else:
- supports_symlinks = False
- _getfinalpathname = None
- __all__ = [
- "PurePath", "PurePosixPath", "PureWindowsPath",
- "Path", "PosixPath", "WindowsPath",
- ]
- #
- # Internals
- #
- _py2 = sys.version_info < (3,)
- _py2_fs_encoding = 'ascii'
- def _py2_fsencode(parts):
- # py2 => minimal unicode support
- return [part.encode(_py2_fs_encoding) if isinstance(part, unicode)
- else part for part in parts]
- def _is_wildcard_pattern(pat):
- # Whether this pattern needs actual matching using fnmatch, or can
- # be looked up directly as a file.
- return "*" in pat or "?" in pat or "[" in pat
- class _Flavour(object):
- """A flavour implements a particular (platform-specific) set of path
- semantics."""
- def __init__(self):
- self.join = self.sep.join
- def parse_parts(self, parts):
- if _py2:
- parts = _py2_fsencode(parts)
- parsed = []
- sep = self.sep
- altsep = self.altsep
- drv = root = ''
- it = reversed(parts)
- for part in it:
- if not part:
- continue
- if altsep:
- part = part.replace(altsep, sep)
- drv, root, rel = self.splitroot(part)
- if sep in rel:
- for x in reversed(rel.split(sep)):
- if x and x != '.':
- parsed.append(intern(x))
- else:
- if rel and rel != '.':
- parsed.append(intern(rel))
- if drv or root:
- if not drv:
- # If no drive is present, try to find one in the previous
- # parts. This makes the result of parsing e.g.
- # ("C:", "/", "a") reasonably intuitive.
- for part in it:
- drv = self.splitroot(part)[0]
- if drv:
- break
- break
- if drv or root:
- parsed.append(drv + root)
- parsed.reverse()
- return drv, root, parsed
- def join_parsed_parts(self, drv, root, parts, drv2, root2, parts2):
- """
- Join the two paths represented by the respective
- (drive, root, parts) tuples. Return a new (drive, root, parts) tuple.
- """
- if root2:
- if not drv2 and drv:
- return drv, root2, [drv + root2] + parts2[1:]
- elif drv2:
- if drv2 == drv or self.casefold(drv2) == self.casefold(drv):
- # Same drive => second path is relative to the first
- return drv, root, parts + parts2[1:]
- else:
- # Second path is non-anchored (common case)
- return drv, root, parts + parts2
- return drv2, root2, parts2
- class _WindowsFlavour(_Flavour):
- # Reference for Windows paths can be found at
- # http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
- sep = '\\'
- altsep = '/'
- has_drv = True
- pathmod = ntpath
- is_supported = (nt is not None)
- drive_letters = (
- set(chr(x) for x in range(ord('a'), ord('z') + 1)) |
- set(chr(x) for x in range(ord('A'), ord('Z') + 1))
- )
- ext_namespace_prefix = '\\\\?\\'
- reserved_names = (
- set(['CON', 'PRN', 'AUX', 'NUL']) |
- set(['COM%d' % i for i in range(1, 10)]) |
- set(['LPT%d' % i for i in range(1, 10)])
- )
- # Interesting findings about extended paths:
- # - '\\?\c:\a', '//?/c:\a' and '//?/c:/a' are all supported
- # but '\\?\c:/a' is not
- # - extended paths are always absolute; "relative" extended paths will
- # fail.
- def splitroot(self, part, sep=sep):
- first = part[0:1]
- second = part[1:2]
- if (second == sep and first == sep):
- # XXX extended paths should also disable the collapsing of "."
- # components (according to MSDN docs).
- prefix, part = self._split_extended_path(part)
- first = part[0:1]
- second = part[1:2]
- else:
- prefix = ''
- third = part[2:3]
- if (second == sep and first == sep and third != sep):
- # is a UNC path:
- # vvvvvvvvvvvvvvvvvvvvv root
- # \\machine\mountpoint\directory\etc\...
- # directory ^^^^^^^^^^^^^^
- index = part.find(sep, 2)
- if index != -1:
- index2 = part.find(sep, index + 1)
- # a UNC path can't have two slashes in a row
- # (after the initial two)
- if index2 != index + 1:
- if index2 == -1:
- index2 = len(part)
- if prefix:
- return prefix + part[1:index2], sep, part[index2+1:]
- else:
- return part[:index2], sep, part[index2+1:]
- drv = root = ''
- if second == ':' and first in self.drive_letters:
- drv = part[:2]
- part = part[2:]
- first = third
- if first == sep:
- root = first
- part = part.lstrip(sep)
- return prefix + drv, root, part
- def casefold(self, s):
- return s.lower()
- def casefold_parts(self, parts):
- return [p.lower() for p in parts]
- def resolve(self, path):
- s = str(path)
- if not s:
- return os.getcwd()
- if _getfinalpathname is not None:
- return self._ext_to_normal(_getfinalpathname(s))
- # Means fallback on absolute
- return None
- def _split_extended_path(self, s, ext_prefix=ext_namespace_prefix):
- prefix = ''
- if s.startswith(ext_prefix):
- prefix = s[:4]
- s = s[4:]
- if s.startswith('UNC\\'):
- prefix += s[:3]
- s = '\\' + s[3:]
- return prefix, s
- def _ext_to_normal(self, s):
- # Turn back an extended path into a normal DOS-like path
- return self._split_extended_path(s)[1]
- def is_reserved(self, parts):
- # NOTE: the rules for reserved names seem somewhat complicated
- # (e.g. r"..\NUL" is reserved but not r"foo\NUL").
- # We err on the side of caution and return True for paths which are
- # not considered reserved by Windows.
- if not parts:
- return False
- if parts[0].startswith('\\\\'):
- # UNC paths are never reserved
- return False
- return parts[-1].partition('.')[0].upper() in self.reserved_names
- def make_uri(self, path):
- # Under Windows, file URIs use the UTF-8 encoding.
- drive = path.drive
- if len(drive) == 2 and drive[1] == ':':
- # It's a path on a local drive => 'file:///c:/a/b'
- rest = path.as_posix()[2:].lstrip('/')
- return 'file:///%s/%s' % (
- drive, urlquote_from_bytes(rest.encode('utf-8')))
- else:
- # It's a path on a network drive => 'file://host/share/a/b'
- return 'file:' + urlquote_from_bytes(path.as_posix().encode('utf-8'))
- class _PosixFlavour(_Flavour):
- sep = '/'
- altsep = ''
- has_drv = False
- pathmod = posixpath
- is_supported = (os.name != 'nt')
- def splitroot(self, part, sep=sep):
- if part and part[0] == sep:
- stripped_part = part.lstrip(sep)
- # According to POSIX path resolution:
- # http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11
- # "A pathname that begins with two successive slashes may be
- # interpreted in an implementation-defined manner, although more
- # than two leading slashes shall be treated as a single slash".
- if len(part) - len(stripped_part) == 2:
- return '', sep * 2, stripped_part
- else:
- return '', sep, stripped_part
- else:
- return '', '', part
- def casefold(self, s):
- return s
- def casefold_parts(self, parts):
- return parts
- def resolve(self, path):
- sep = self.sep
- accessor = path._accessor
- seen = {}
- def _resolve(path, rest):
- if rest.startswith(sep):
- path = ''
- for name in rest.split(sep):
- if not name or name == '.':
- # current dir
- continue
- if name == '..':
- # parent dir
- path, _, _ = path.rpartition(sep)
- continue
- newpath = path + sep + name
- if newpath in seen:
- # Already seen this path
- path = seen[newpath]
- if path is not None:
- # use cached value
- continue
- # The symlink is not resolved, so we must have a symlink loop.
- raise RuntimeError("Symlink loop from %r" % newpath)
- # Resolve the symbolic link
- try:
- target = accessor.readlink(newpath)
- except OSError as e:
- if e.errno != EINVAL:
- raise
- # Not a symlink
- path = newpath
- else:
- seen[newpath] = None # not resolved symlink
- path = _resolve(path, target)
- seen[newpath] = path # resolved symlink
- return path
- # NOTE: according to POSIX, getcwd() cannot contain path components
- # which are symlinks.
- base = '' if path.is_absolute() else os.getcwd()
- return _resolve(base, str(path)) or sep
- def is_reserved(self, parts):
- return False
- def make_uri(self, path):
- # We represent the path using the local filesystem encoding,
- # for portability to other applications.
- bpath = bytes(path)
- return 'file://' + urlquote_from_bytes(bpath)
- _windows_flavour = _WindowsFlavour()
- _posix_flavour = _PosixFlavour()
- class _Accessor:
- """An accessor implements a particular (system-specific or not) way of
- accessing paths on the filesystem."""
- class _NormalAccessor(_Accessor):
- def _wrap_strfunc(strfunc):
- @functools.wraps(strfunc)
- def wrapped(pathobj, *args):
- return strfunc(str(pathobj), *args)
- return staticmethod(wrapped)
- def _wrap_binary_strfunc(strfunc):
- @functools.wraps(strfunc)
- def wrapped(pathobjA, pathobjB, *args):
- return strfunc(str(pathobjA), str(pathobjB), *args)
- return staticmethod(wrapped)
- stat = _wrap_strfunc(os.stat)
- lstat = _wrap_strfunc(os.lstat)
- open = _wrap_strfunc(os.open)
- listdir = _wrap_strfunc(os.listdir)
- chmod = _wrap_strfunc(os.chmod)
- if hasattr(os, "lchmod"):
- lchmod = _wrap_strfunc(os.lchmod)
- else:
- def lchmod(self, pathobj, mode):
- raise NotImplementedError("lchmod() not available on this system")
- mkdir = _wrap_strfunc(os.mkdir)
- unlink = _wrap_strfunc(os.unlink)
- rmdir = _wrap_strfunc(os.rmdir)
- rename = _wrap_binary_strfunc(os.rename)
- if sys.version_info >= (3, 3):
- replace = _wrap_binary_strfunc(os.replace)
- if nt:
- if supports_symlinks:
- symlink = _wrap_binary_strfunc(os.symlink)
- else:
- def symlink(a, b, target_is_directory):
- raise NotImplementedError("symlink() not available on this system")
- else:
- # Under POSIX, os.symlink() takes two args
- @staticmethod
- def symlink(a, b, target_is_directory):
- return os.symlink(str(a), str(b))
- utime = _wrap_strfunc(os.utime)
- # Helper for resolve()
- def readlink(self, path):
- return os.readlink(path)
- _normal_accessor = _NormalAccessor()
- #
- # Globbing helpers
- #
- @contextmanager
- def _cached(func):
- try:
- func.__cached__
- yield func
- except AttributeError:
- cache = {}
- def wrapper(*args):
- try:
- return cache[args]
- except KeyError:
- value = cache[args] = func(*args)
- return value
- wrapper.__cached__ = True
- try:
- yield wrapper
- finally:
- cache.clear()
- def _make_selector(pattern_parts):
- pat = pattern_parts[0]
- child_parts = pattern_parts[1:]
- if pat == '**':
- cls = _RecursiveWildcardSelector
- elif '**' in pat:
- raise ValueError("Invalid pattern: '**' can only be an entire path component")
- elif _is_wildcard_pattern(pat):
- cls = _WildcardSelector
- else:
- cls = _PreciseSelector
- return cls(pat, child_parts)
- if hasattr(functools, "lru_cache"):
- _make_selector = functools.lru_cache()(_make_selector)
- class _Selector:
- """A selector matches a specific glob pattern part against the children
- of a given path."""
- def __init__(self, child_parts):
- self.child_parts = child_parts
- if child_parts:
- self.successor = _make_selector(child_parts)
- else:
- self.successor = _TerminatingSelector()
- def select_from(self, parent_path):
- """Iterate over all child paths of `parent_path` matched by this
- selector. This can contain parent_path itself."""
- path_cls = type(parent_path)
- is_dir = path_cls.is_dir
- exists = path_cls.exists
- listdir = parent_path._accessor.listdir
- return self._select_from(parent_path, is_dir, exists, listdir)
- class _TerminatingSelector:
- def _select_from(self, parent_path, is_dir, exists, listdir):
- yield parent_path
- class _PreciseSelector(_Selector):
- def __init__(self, name, child_parts):
- self.name = name
- _Selector.__init__(self, child_parts)
- def _select_from(self, parent_path, is_dir, exists, listdir):
- if not is_dir(parent_path):
- return
- path = parent_path._make_child_relpath(self.name)
- if exists(path):
- for p in self.successor._select_from(path, is_dir, exists, listdir):
- yield p
- class _WildcardSelector(_Selector):
- def __init__(self, pat, child_parts):
- self.pat = re.compile(fnmatch.translate(pat))
- _Selector.__init__(self, child_parts)
- def _select_from(self, parent_path, is_dir, exists, listdir):
- if not is_dir(parent_path):
- return
- cf = parent_path._flavour.casefold
- for name in listdir(parent_path):
- casefolded = cf(name)
- if self.pat.match(casefolded):
- path = parent_path._make_child_relpath(name)
- for p in self.successor._select_from(path, is_dir, exists, listdir):
- yield p
- class _RecursiveWildcardSelector(_Selector):
- def __init__(self, pat, child_parts):
- _Selector.__init__(self, child_parts)
- def _iterate_directories(self, parent_path, is_dir, listdir):
- yield parent_path
- for name in listdir(parent_path):
- path = parent_path._make_child_relpath(name)
- if is_dir(path):
- for p in self._iterate_directories(path, is_dir, listdir):
- yield p
- def _select_from(self, parent_path, is_dir, exists, listdir):
- if not is_dir(parent_path):
- return
- with _cached(listdir) as listdir:
- yielded = set()
- try:
- successor_select = self.successor._select_from
- for starting_point in self._iterate_directories(parent_path, is_dir, listdir):
- for p in successor_select(starting_point, is_dir, exists, listdir):
- if p not in yielded:
- yield p
- yielded.add(p)
- finally:
- yielded.clear()
- #
- # Public API
- #
- class _PathParents(Sequence):
- """This object provides sequence-like access to the logical ancestors
- of a path. Don't try to construct it yourself."""
- __slots__ = ('_pathcls', '_drv', '_root', '_parts')
- def __init__(self, path):
- # We don't store the instance to avoid reference cycles
- self._pathcls = type(path)
- self._drv = path._drv
- self._root = path._root
- self._parts = path._parts
- def __len__(self):
- if self._drv or self._root:
- return len(self._parts) - 1
- else:
- return len(self._parts)
- def __getitem__(self, idx):
- if idx < 0 or idx >= len(self):
- raise IndexError(idx)
- return self._pathcls._from_parsed_parts(self._drv, self._root,
- self._parts[:-idx - 1])
- def __repr__(self):
- return "<{0}.parents>".format(self._pathcls.__name__)
- class PurePath(object):
- """PurePath represents a filesystem path and offers operations which
- don't imply any actual filesystem I/O. Depending on your system,
- instantiating a PurePath will return either a PurePosixPath or a
- PureWindowsPath object. You can also instantiate either of these classes
- directly, regardless of your system.
- """
- __slots__ = (
- '_drv', '_root', '_parts',
- '_str', '_hash', '_pparts', '_cached_cparts',
- )
- def __new__(cls, *args):
- """Construct a PurePath from one or several strings and or existing
- PurePath objects. The strings and path objects are combined so as
- to yield a canonicalized path, which is incorporated into the
- new PurePath object.
- """
- if cls is PurePath:
- cls = PureWindowsPath if os.name == 'nt' else PurePosixPath
- return cls._from_parts(args)
- def __reduce__(self):
- # Using the parts tuple helps share interned path parts
- # when pickling related paths.
- return (self.__class__, tuple(self._parts))
- @classmethod
- def _parse_args(cls, args):
- # This is useful when you don't want to create an instance, just
- # canonicalize some constructor arguments.
- parts = []
- for a in args:
- if isinstance(a, PurePath):
- parts += a._parts
- elif isinstance(a, basestring):
- parts.append(a)
- else:
- raise TypeError(
- "argument should be a path or str object, not %r"
- % type(a))
- return cls._flavour.parse_parts(parts)
- @classmethod
- def _from_parts(cls, args, init=True):
- # We need to call _parse_args on the instance, so as to get the
- # right flavour.
- self = object.__new__(cls)
- drv, root, parts = self._parse_args(args)
- self._drv = drv
- self._root = root
- self._parts = parts
- if init:
- self._init()
- return self
- @classmethod
- def _from_parsed_parts(cls, drv, root, parts, init=True):
- self = object.__new__(cls)
- self._drv = drv
- self._root = root
- self._parts = parts
- if init:
- self._init()
- return self
- @classmethod
- def _format_parsed_parts(cls, drv, root, parts):
- if drv or root:
- return drv + root + cls._flavour.join(parts[1:])
- else:
- return cls._flavour.join(parts)
- def _init(self):
- # Overriden in concrete Path
- pass
- def _make_child(self, args):
- drv, root, parts = self._parse_args(args)
- drv, root, parts = self._flavour.join_parsed_parts(
- self._drv, self._root, self._parts, drv, root, parts)
- return self._from_parsed_parts(drv, root, parts)
- def __str__(self):
- """Return the string representation of the path, suitable for
- passing to system calls."""
- try:
- return self._str
- except AttributeError:
- self._str = self._format_parsed_parts(self._drv, self._root,
- self._parts) or '.'
- return self._str
- def as_posix(self):
- """Return the string representation of the path with forward (/)
- slashes."""
- f = self._flavour
- return str(self).replace(f.sep, '/')
- def __bytes__(self):
- """Return the bytes representation of the path. This is only
- recommended to use under Unix."""
- if sys.version_info < (3, 2):
- raise NotImplementedError("needs Python 3.2 or later")
- return os.fsencode(str(self))
- def __repr__(self):
- return "{0}({1!r})".format(self.__class__.__name__, self.as_posix())
- def as_uri(self):
- """Return the path as a 'file' URI."""
- if not self.is_absolute():
- raise ValueError("relative path can't be expressed as a file URI")
- return self._flavour.make_uri(self)
- @property
- def _cparts(self):
- # Cached casefolded parts, for hashing and comparison
- try:
- return self._cached_cparts
- except AttributeError:
- self._cached_cparts = self._flavour.casefold_parts(self._parts)
- return self._cached_cparts
- def __eq__(self, other):
- if not isinstance(other, PurePath):
- return NotImplemented
- return self._cparts == other._cparts and self._flavour is other._flavour
- def __ne__(self, other):
- return not self == other
- def __hash__(self):
- try:
- return self._hash
- except AttributeError:
- self._hash = hash(tuple(self._cparts))
- return self._hash
- def __lt__(self, other):
- if not isinstance(other, PurePath) or self._flavour is not other._flavour:
- return NotImplemented
- return self._cparts < other._cparts
- def __le__(self, other):
- if not isinstance(other, PurePath) or self._flavour is not other._flavour:
- return NotImplemented
- return self._cparts <= other._cparts
- def __gt__(self, other):
- if not isinstance(other, PurePath) or self._flavour is not other._flavour:
- return NotImplemented
- return self._cparts > other._cparts
- def __ge__(self, other):
- if not isinstance(other, PurePath) or self._flavour is not other._flavour:
- return NotImplemented
- return self._cparts >= other._cparts
- drive = property(attrgetter('_drv'),
- doc="""The drive prefix (letter or UNC path), if any.""")
- root = property(attrgetter('_root'),
- doc="""The root of the path, if any.""")
- @property
- def anchor(self):
- """The concatenation of the drive and root, or ''."""
- anchor = self._drv + self._root
- return anchor
- @property
- def name(self):
- """The final path component, if any."""
- parts = self._parts
- if len(parts) == (1 if (self._drv or self._root) else 0):
- return ''
- return parts[-1]
- @property
- def suffix(self):
- """The final component's last suffix, if any."""
- name = self.name
- i = name.rfind('.')
- if 0 < i < len(name) - 1:
- return name[i:]
- else:
- return ''
- @property
- def suffixes(self):
- """A list of the final component's suffixes, if any."""
- name = self.name
- if name.endswith('.'):
- return []
- name = name.lstrip('.')
- return ['.' + suffix for suffix in name.split('.')[1:]]
- @property
- def stem(self):
- """The final path component, minus its last suffix."""
- name = self.name
- i = name.rfind('.')
- if 0 < i < len(name) - 1:
- return name[:i]
- else:
- return name
- def with_name(self, name):
- """Return a new path with the file name changed."""
- if not self.name:
- raise ValueError("%r has an empty name" % (self,))
- return self._from_parsed_parts(self._drv, self._root,
- self._parts[:-1] + [name])
- def with_suffix(self, suffix):
- """Return a new path with the file suffix changed (or added, if none)."""
- # XXX if suffix is None, should the current suffix be removed?
- drv, root, parts = self._flavour.parse_parts((suffix,))
- if drv or root or len(parts) != 1:
- raise ValueError("Invalid suffix %r" % (suffix))
- suffix = parts[0]
- if not suffix.startswith('.'):
- raise ValueError("Invalid suffix %r" % (suffix))
- name = self.name
- if not name:
- raise ValueError("%r has an empty name" % (self,))
- old_suffix = self.suffix
- if not old_suffix:
- name = name + suffix
- else:
- name = name[:-len(old_suffix)] + suffix
- return self._from_parsed_parts(self._drv, self._root,
- self._parts[:-1] + [name])
- def relative_to(self, *other):
- """Return the relative path to another path identified by the passed
- arguments. If the operation is not possible (because this is not
- a subpath of the other path), raise ValueError.
- """
- # For the purpose of this method, drive and root are considered
- # separate parts, i.e.:
- # Path('c:/').relative_to('c:') gives Path('/')
- # Path('c:/').relative_to('/') raise ValueError
- if not other:
- raise TypeError("need at least one argument")
- parts = self._parts
- drv = self._drv
- root = self._root
- if root:
- abs_parts = [drv, root] + parts[1:]
- else:
- abs_parts = parts
- to_drv, to_root, to_parts = self._parse_args(other)
- if to_root:
- to_abs_parts = [to_drv, to_root] + to_parts[1:]
- else:
- to_abs_parts = to_parts
- n = len(to_abs_parts)
- cf = self._flavour.casefold_parts
- if (root or drv) if n == 0 else cf(abs_parts[:n]) != cf(to_abs_parts):
- formatted = self._format_parsed_parts(to_drv, to_root, to_parts)
- raise ValueError("{!r} does not start with {!r}"
- .format(str(self), str(formatted)))
- return self._from_parsed_parts('', root if n == 1 else '',
- abs_parts[n:])
- @property
- def parts(self):
- """An object providing sequence-like access to the
- components in the filesystem path."""
- # We cache the tuple to avoid building a new one each time .parts
- # is accessed. XXX is this necessary?
- try:
- return self._pparts
- except AttributeError:
- self._pparts = tuple(self._parts)
- return self._pparts
- def joinpath(self, *args):
- """Combine this path with one or several arguments, and return a
- new path representing either a subpath (if all arguments are relative
- paths) or a totally different path (if one of the arguments is
- anchored).
- """
- return self._make_child(args)
- def __truediv__(self, key):
- return self._make_child((key,))
- def __rtruediv__(self, key):
- return self._from_parts([key] + self._parts)
- if sys.version_info < (3,):
- __div__ = __truediv__
- __rdiv__ = __rtruediv__
- @property
- def parent(self):
- """The logical parent of the path."""
- drv = self._drv
- root = self._root
- parts = self._parts
- if len(parts) == 1 and (drv or root):
- return self
- return self._from_parsed_parts(drv, root, parts[:-1])
- @property
- def parents(self):
- """A sequence of this path's logical parents."""
- return _PathParents(self)
- def is_absolute(self):
- """True if the path is absolute (has both a root and, if applicable,
- a drive)."""
- if not self._root:
- return False
- return not self._flavour.has_drv or bool(self._drv)
- def is_reserved(self):
- """Return True if the path contains one of the special names reserved
- by the system, if any."""
- return self._flavour.is_reserved(self._parts)
- def match(self, path_pattern):
- """
- Return True if this path matches the given pattern.
- """
- cf = self._flavour.casefold
- path_pattern = cf(path_pattern)
- drv, root, pat_parts = self._flavour.parse_parts((path_pattern,))
- if not pat_parts:
- raise ValueError("empty pattern")
- if drv and drv != cf(self._drv):
- return False
- if root and root != cf(self._root):
- return False
- parts = self._cparts
- if drv or root:
- if len(pat_parts) != len(parts):
- return False
- pat_parts = pat_parts[1:]
- elif len(pat_parts) > len(parts):
- return False
- for part, pat in zip(reversed(parts), reversed(pat_parts)):
- if not fnmatch.fnmatchcase(part, pat):
- return False
- return True
- class PurePosixPath(PurePath):
- _flavour = _posix_flavour
- __slots__ = ()
- class PureWindowsPath(PurePath):
- _flavour = _windows_flavour
- __slots__ = ()
- # Filesystem-accessing classes
- class Path(PurePath):
- __slots__ = (
- '_accessor',
- )
- def __new__(cls, *args, **kwargs):
- if cls is Path:
- cls = WindowsPath if os.name == 'nt' else PosixPath
- self = cls._from_parts(args, init=False)
- if not self._flavour.is_supported:
- raise NotImplementedError("cannot instantiate %r on your system"
- % (cls.__name__,))
- self._init()
- return self
- def _init(self,
- # Private non-constructor arguments
- template=None,
- ):
- if template is not None:
- self._accessor = template._accessor
- else:
- self._accessor = _normal_accessor
- def _make_child_relpath(self, part):
- # This is an optimization used for dir walking. `part` must be
- # a single part relative to this path.
- parts = self._parts + [part]
- return self._from_parsed_parts(self._drv, self._root, parts)
- def _opener(self, name, flags, mode=0o666):
- # A stub for the opener argument to built-in open()
- return self._accessor.open(self, flags, mode)
- def _raw_open(self, flags, mode=0o777):
- """
- Open the file pointed by this path and return a file descriptor,
- as os.open() does.
- """
- return self._accessor.open(self, flags, mode)
- # Public API
- @classmethod
- def cwd(cls):
- """Return a new path pointing to the current working directory
- (as returned by os.getcwd()).
- """
- return cls(os.getcwd())
- def iterdir(self):
- """Iterate over the files in this directory. Does not yield any
- result for the special paths '.' and '..'.
- """
- for name in self._accessor.listdir(self):
- if name in ('.', '..'):
- # Yielding a path object for these makes little sense
- continue
- yield self._make_child_relpath(name)
- def glob(self, pattern):
- """Iterate over this subtree and yield all existing files (of any
- kind, including directories) matching the given pattern.
- """
- pattern = self._flavour.casefold(pattern)
- drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
- if drv or root:
- raise NotImplementedError("Non-relative patterns are unsupported")
- selector = _make_selector(tuple(pattern_parts))
- for p in selector.select_from(self):
- yield p
- def rglob(self, pattern):
- """Recursively yield all existing files (of any kind, including
- directories) matching the given pattern, anywhere in this subtree.
- """
- pattern = self._flavour.casefold(pattern)
- drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
- if drv or root:
- raise NotImplementedError("Non-relative patterns are unsupported")
- selector = _make_selector(("**",) + tuple(pattern_parts))
- for p in selector.select_from(self):
- yield p
- def absolute(self):
- """Return an absolute version of this path. This function works
- even if the path doesn't point to anything.
- No normalization is done, i.e. all '.' and '..' will be kept along.
- Use resolve() to get the canonical path to a file.
- """
- # XXX untested yet!
- if self.is_absolute():
- return self
- # FIXME this must defer to the specific flavour (and, under Windows,
- # use nt._getfullpathname())
- obj = self._from_parts([os.getcwd()] + self._parts, init=False)
- obj._init(template=self)
- return obj
- def resolve(self):
- """
- Make the path absolute, resolving all symlinks on the way and also
- normalizing it (for example turning slashes into backslashes under
- Windows).
- """
- s = self._flavour.resolve(self)
- if s is None:
- # No symlink resolution => for consistency, raise an error if
- # the path doesn't exist or is forbidden
- self.stat()
- s = str(self.absolute())
- # Now we have no symlinks in the path, it's safe to normalize it.
- normed = self._flavour.pathmod.normpath(s)
- obj = self._from_parts((normed,), init=False)
- obj._init(template=self)
- return obj
- def stat(self):
- """
- Return the result of the stat() system call on this path, like
- os.stat() does.
- """
- return self._accessor.stat(self)
- def owner(self):
- """
- Return the login name of the file owner.
- """
- import pwd
- return pwd.getpwuid(self.stat().st_uid).pw_name
- def group(self):
- """
- Return the group name of the file gid.
- """
- import grp
- return grp.getgrgid(self.stat().st_gid).gr_name
- def open(self, mode='r', buffering=-1, encoding=None,
- errors=None, newline=None):
- """
- Open the file pointed by this path and return a file object, as
- the built-in open() function does.
- """
- if sys.version_info >= (3, 3):
- return io.open(str(self), mode, buffering, encoding, errors, newline,
- opener=self._opener)
- else:
- return io.open(str(self), mode, buffering, encoding, errors, newline)
- def touch(self, mode=0o666, exist_ok=True):
- """
- Create this file with the given access mode, if it doesn't exist.
- """
- if exist_ok:
- # First try to bump modification time
- # Implementation note: GNU touch uses the UTIME_NOW option of
- # the utimensat() / futimens() functions.
- t = time.time()
- try:
- self._accessor.utime(self, (t, t))
- except OSError:
- # Avoid exception chaining
- pass
- else:
- return
- flags = os.O_CREAT | os.O_WRONLY
- if not exist_ok:
- flags |= os.O_EXCL
- fd = self._raw_open(flags, mode)
- os.close(fd)
- def mkdir(self, mode=0o777, parents=False):
- if not parents:
- self._accessor.mkdir(self, mode)
- else:
- try:
- self._accessor.mkdir(self, mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- self.parent.mkdir(parents=True)
- self._accessor.mkdir(self, mode)
- def chmod(self, mode):
- """
- Change the permissions of the path, like os.chmod().
- """
- self._accessor.chmod(self, mode)
- def lchmod(self, mode):
- """
- Like chmod(), except if the path points to a symlink, the symlink's
- permissions are changed, rather than its target's.
- """
- self._accessor.lchmod(self, mode)
- def unlink(self):
- """
- Remove this file or link.
- If the path is a directory, use rmdir() instead.
- """
- self._accessor.unlink(self)
- def rmdir(self):
- """
- Remove this directory. The directory must be empty.
- """
- self._accessor.rmdir(self)
- def lstat(self):
- """
- Like stat(), except if the path points to a symlink, the symlink's
- status information is returned, rather than its target's.
- """
- return self._accessor.lstat(self)
- def rename(self, target):
- """
- Rename this path to the given path.
- """
- self._accessor.rename(self, target)
- def replace(self, target):
- """
- Rename this path to the given path, clobbering the existing
- destination if it exists.
- """
- if sys.version_info < (3, 3):
- raise NotImplementedError("replace() is only available "
- "with Python 3.3 and later")
- self._accessor.replace(self, target)
- def symlink_to(self, target, target_is_directory=False):
- """
- Make this path a symlink pointing to the given path.
- Note the order of arguments (self, target) is the reverse of os.symlink's.
- """
- self._accessor.symlink(target, self, target_is_directory)
- # Convenience functions for querying the stat results
- def exists(self):
- """
- Whether this path exists.
- """
- try:
- self.stat()
- except OSError as e:
- if e.errno != ENOENT:
- raise
- return False
- return True
- def is_dir(self):
- """
- Whether this path is a directory.
- """
- try:
- return S_ISDIR(self.stat().st_mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- # Path doesn't exist or is a broken symlink
- # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
- return False
- def is_file(self):
- """
- Whether this path is a regular file (also True for symlinks pointing
- to regular files).
- """
- try:
- return S_ISREG(self.stat().st_mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- # Path doesn't exist or is a broken symlink
- # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
- return False
- def is_symlink(self):
- """
- Whether this path is a symbolic link.
- """
- try:
- return S_ISLNK(self.lstat().st_mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- # Path doesn't exist
- return False
- def is_block_device(self):
- """
- Whether this path is a block device.
- """
- try:
- return S_ISBLK(self.stat().st_mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- # Path doesn't exist or is a broken symlink
- # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
- return False
- def is_char_device(self):
- """
- Whether this path is a character device.
- """
- try:
- return S_ISCHR(self.stat().st_mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- # Path doesn't exist or is a broken symlink
- # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
- return False
- def is_fifo(self):
- """
- Whether this path is a FIFO.
- """
- try:
- return S_ISFIFO(self.stat().st_mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- # Path doesn't exist or is a broken symlink
- # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
- return False
- def is_socket(self):
- """
- Whether this path is a socket.
- """
- try:
- return S_ISSOCK(self.stat().st_mode)
- except OSError as e:
- if e.errno != ENOENT:
- raise
- # Path doesn't exist or is a broken symlink
- # (see https://bitbucket.org/pitrou/pathlib/issue/12/)
- return False
- class PosixPath(Path, PurePosixPath):
- __slots__ = ()
- class WindowsPath(Path, PureWindowsPath):
- __slots__ = ()
|