Skip to content
Snippets Groups Projects
posixpath.py 16.6 KiB
Newer Older
  • Learn to ignore specific revisions
  • """Common operations on Posix pathnames.
    
    Instead of importing this module directly, import os and refer to
    this module as os.path.  The "os.path" name is an alias for this
    
    module on Posix systems; on other systems (e.g. Windows),
    
    os.path provides the same operations in a manner specific to that
    
    platform, and is an alias to another module (e.g. ntpath).
    
    
    Some of this can actually be useful on non-Posix systems too, e.g.
    for manipulation of the pathname component of URLs.
    
    # Strings representing various path-related bits and pieces.
    # These are primarily for export; internally, they are hardcoded.
    # Should be set before imports for resolving cyclic dependency.
    curdir = '.'
    pardir = '..'
    extsep = '.'
    sep = '/'
    pathsep = ':'
    
    from genericpath import *
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    
    
    __all__ = ["normcase","isabs","join","splitdrive","split","splitext",
               "basename","dirname","commonprefix","getsize","getmtime",
    
               "getatime","getctime","islink","exists","lexists","isdir","isfile",
    
    Benjamin Peterson's avatar
    Benjamin Peterson committed
               "ismount", "expanduser","expandvars","normpath","abspath",
    
               "samefile","sameopenfile","samestat",
    
               "curdir","pardir","sep","pathsep","defpath","altsep","extsep",
    
               "devnull","realpath","supports_unicode_filenames","relpath",
               "commonpath"]
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    
    
    def _get_sep(path):
        if isinstance(path, bytes):
            return b'/'
        else:
            return '/'
    
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Normalize the case of a pathname.  Trivial in Posix, string.lower on Mac.
    # On MS-DOS this may also turn slashes into backslashes; however, other
    # normalizations (such as optimizing '../' away) are not allowed
    # (another function should be defined to do that).
    
    def normcase(s):
    
        """Normalize case of pathname.  Has no effect under Posix"""
    
    Jeremy Hylton's avatar
    Jeremy Hylton committed
    # Return whether a path is absolute.
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Trivial in Posix, harder on the Mac or MS-DOS.
    
    def isabs(s):
    
        sep = _get_sep(s)
        return s.startswith(sep)
    
    # Join pathnames.
    # Ignore the previous parts if a part is absolute.
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Insert a '/' unless the first part is empty or already ends in '/'.
    
    def join(a, *p):
    
        """Join two or more pathname components, inserting '/' as needed.
        If any component is an absolute path, all previous path components
    
        will be discarded.  An empty last part will result in a path that
        ends with a separator."""
    
            if not p:
                path[:0] + sep  #23780: Ensure compatible data type even if p is null.
    
                if b.startswith(sep):
                    path = b
                elif not path or path.endswith(sep):
                    path += b
                else:
                    path += sep + b
    
        except (TypeError, AttributeError, BytesWarning):
            genericpath._check_arg_types('join', a, *p)
            raise
    
    # Split a path in head (everything up to the last '/') and tail (the
    
    # rest).  If the path ends in '/', tail will be empty.  If there is no
    # '/' in the path, head  will be empty.
    # Trailing '/'es are stripped from head unless it is the root.
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    def split(p):
    
    Tim Peters's avatar
    Tim Peters committed
        """Split a pathname.  Returns tuple "(head, tail)" where "tail" is
    
    Fred Drake's avatar
    Fred Drake committed
        everything after the final slash.  Either part may be empty."""
    
        if head and head != sep*len(head):
            head = head.rstrip(sep)
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Split a path in root and extension.
    
    # The extension is everything starting at the last dot in the last
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # pathname component; the root is everything before that.
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # It is always true that root + ext == p.
    
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    def splitext(p):
    
        if isinstance(p, bytes):
            sep = b'/'
            extsep = b'.'
        else:
            sep = '/'
            extsep = '.'
        return genericpath._splitext(p, sep, None, extsep)
    
    splitext.__doc__ = genericpath._splitext.__doc__
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Split a pathname into a drive specification and the rest of the
    # path.  Useful on DOS/Windows/NT; on Unix, the drive is always empty.
    
    def splitdrive(p):
    
    Tim Peters's avatar
    Tim Peters committed
        """Split a pathname into drive and path. On Posix, drive is always
    
    Fred Drake's avatar
    Fred Drake committed
        empty."""
    
    # Return the tail (basename) part of a path, same as split(path)[1].
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    def basename(p):
    
        """Returns the final component of a pathname"""
    
    # Return the head (dirname) part of a path, same as split(path)[0].
    
        """Returns the directory component of a pathname"""
    
        if head and head != sep*len(head):
            head = head.rstrip(sep)
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Is a path a symbolic link?
    
    # This will always return false on systems where os.lstat doesn't exist.
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    
    def islink(path):
    
        """Test whether a path is a symbolic link"""
        try:
            st = os.lstat(path)
    
        except (OSError, ValueError, AttributeError):
    
    # Being true for dangling symbolic links is also useful.
    
    def lexists(path):
        """Test whether a path exists.  Returns True for broken symbolic links"""
        try:
    
    Georg Brandl's avatar
    Georg Brandl committed
            os.lstat(path)
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Is a path a mount point?
    
    # (Does this work for all UNIXes?  Is it even guaranteed to work by Posix?)
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    def ismount(path):
    
        """Test whether a path is a mount point"""
        try:
    
            # It doesn't exist -- so not a mount point. :-)
            return False
        else:
    
            if stat.S_ISLNK(s1.st_mode):
                return False
    
    
        if isinstance(path, bytes):
            parent = join(path, b'..')
        else:
            parent = join(path, '..')
    
            return True     # path/.. on a different device as path
    
            return True     # path/.. is the same i-node as path
        return False
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    # Expand paths beginning with '~' or '~user'.
    # '~' means $HOME; '~user' means that user's home directory.
    # If the path doesn't begin with '~', or if the user or $HOME is unknown,
    # the path is returned unchanged (leaving error reporting to whatever
    # function is called with the expanded path as argument).
    # See also module 'glob' for expansion of *, ? and [...] in pathnames.
    # (A function should also be defined to do full *sh-style environment
    # variable expansion.)
    
    def expanduser(path):
    
    Tim Peters's avatar
    Tim Peters committed
        """Expand ~ and ~user constructions.  If user or $HOME is unknown,
    
    Fred Drake's avatar
    Fred Drake committed
        do nothing."""
    
        if isinstance(path, bytes):
            tilde = b'~'
        else:
            tilde = '~'
        if not path.startswith(tilde):
    
        sep = _get_sep(path)
        i = path.find(sep, 1)
    
                try:
                    import pwd
                except ImportError:
                    # pwd module unavailable, return path unchanged
                    return path
    
                try:
                    userhome = pwd.getpwuid(os.getuid()).pw_dir
                except KeyError:
                    # bpo-10496: if the current user identifier doesn't exist in the
                    # password database, return the path unchanged
                    return path
    
            else:
                userhome = os.environ['HOME']
    
            try:
                import pwd
            except ImportError:
                # pwd module unavailable, return path unchanged
                return path
    
            name = path[1:i]
            if isinstance(name, bytes):
                name = str(name, 'ASCII')
    
                # bpo-10496: if the user name from the path doesn't exist in the
                # password database, return the path unchanged
    
        # if no user home, return the path unchanged on VxWorks
        if userhome is None and sys.platform == "vxworks":
            return path
    
            userhome = os.fsencode(userhome)
    
    Benjamin Peterson's avatar
    Benjamin Peterson committed
            root = b'/'
        else:
            root = '/'
    
        userhome = userhome.rstrip(root)
        return (userhome + path[i:]) or root
    
    
    
    # Expand paths containing shell variable substitutions.
    
    # This expands the forms $variable and ${variable} only.
    
    Jeremy Hylton's avatar
    Jeremy Hylton committed
    # Non-existent variables are left unchanged.
    
    
    def expandvars(path):
    
        """Expand shell variables of form $var and ${var}.  Unknown variables
    
    Fred Drake's avatar
    Fred Drake committed
        are left unchanged."""
    
        global _varprog, _varprogb
        if isinstance(path, bytes):
            if b'$' not in path:
                return path
            if not _varprogb:
                import re
                _varprogb = re.compile(br'\$(\w+|\{[^}]*\})', re.ASCII)
            search = _varprogb.search
            start = b'{'
            end = b'}'
    
            environ = getattr(os, 'environb', None)
    
        else:
            if '$' not in path:
                return path
            if not _varprog:
                import re
                _varprog = re.compile(r'\$(\w+|\{[^}]*\})', re.ASCII)
            search = _varprog.search
            start = '{'
            end = '}'
    
            if name.startswith(start) and name.endswith(end):
    
                    value = os.fsencode(os.environ[os.fsdecode(name)])
    
                else:
                    value = environ[name]
            except KeyError:
                i = j
            else:
    
    
    
    # Normalize a path, e.g. A//B, A/./B and A/foo/../B all become A/B.
    # It should be understood that this may change the meaning of the path
    # if it contains symbolic links!
    
    
    try:
        from posix import _path_normpath
    
    except ImportError:
        def normpath(path):
            """Normalize path, eliminating double slashes, etc."""
            path = os.fspath(path)
            if isinstance(path, bytes):
                sep = b'/'
                empty = b''
                dot = b'.'
                dotdot = b'..'
            else:
                sep = '/'
                empty = ''
                dot = '.'
                dotdot = '..'
            if path == empty:
                return dot
            initial_slashes = path.startswith(sep)
            # POSIX allows one or two initial slashes, but treats three or more
            # as single slash.
    
            # (see https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13)
    
            if (initial_slashes and
                path.startswith(sep*2) and not path.startswith(sep*3)):
                initial_slashes = 2
            comps = path.split(sep)
            new_comps = []
            for comp in comps:
                if comp in (empty, dot):
                    continue
                if (comp != dotdot or (not initial_slashes and not new_comps) or
                     (new_comps and new_comps[-1] == dotdot)):
                    new_comps.append(comp)
                elif new_comps:
                    new_comps.pop()
            comps = new_comps
            path = sep.join(comps)
            if initial_slashes:
                path = sep*initial_slashes + path
            return path or dot
    
    else:
        def normpath(path):
            """Normalize path, eliminating double slashes, etc."""
            path = os.fspath(path)
            if isinstance(path, bytes):
                return os.fsencode(_path_normpath(os.fsdecode(path))) or b"."
            return _path_normpath(path) or "."
    
    Guido van Rossum's avatar
    Guido van Rossum committed
    
    
    def abspath(path):
    
    Guido van Rossum's avatar
    Guido van Rossum committed
        if not isabs(path):
    
            if isinstance(path, bytes):
                cwd = os.getcwdb()
            else:
                cwd = os.getcwd()
            path = join(cwd, path)
    
    Guido van Rossum's avatar
    Guido van Rossum committed
        return normpath(path)
    
    
    
    # Return a canonical path (i.e. the absolute location of a file on the
    # filesystem).
    
    
        """Return the canonical path of the specified filename, eliminating any
    symbolic links encountered in the path."""
    
        filename = os.fspath(filename)
    
        path, ok = _joinrealpath(filename[:0], filename, strict, {})
    
    # Join two paths, normalizing and eliminating any symbolic links
    
    def _joinrealpath(path, rest, strict, seen):
    
            curdir = '.'
            pardir = '..'
    
        if isabs(rest):
            rest = rest[1:]
            path = sep
    
        while rest:
            name, _, rest = rest.partition(sep)
            if not name or name == curdir:
                # current dir
                continue
            if name == pardir:
                # parent dir
                if path:
    
                    path, name = split(path)
                    if name == pardir:
                        path = join(path, pardir, pardir)
    
            try:
                st = os.lstat(newpath)
            except OSError:
                if strict:
                    raise
                is_link = False
            else:
                is_link = stat.S_ISLNK(st.st_mode)
            if not is_link:
    
                path = newpath
                continue
            # Resolve the symbolic link
            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.
    
                if strict:
                    # Raise OSError(errno.ELOOP)
                    os.stat(newpath)
                else:
                    # Return already resolved part + rest of the path unchanged.
                    return join(newpath, rest), False
    
            path, ok = _joinrealpath(path, os.readlink(newpath), strict, seen)
    
            if not ok:
                return join(path, rest), False
            seen[newpath] = path # resolved symlink
    
        return path, True
    
    
    supports_unicode_filenames = (sys.platform == 'darwin')
    
        """Return a relative version of a path"""
    
        if not path:
            raise ValueError("no path specified")
    
    
        if isinstance(path, bytes):
            curdir = b'.'
            sep = b'/'
            pardir = b'..'
        else:
            curdir = '.'
            sep = '/'
            pardir = '..'
    
        if start is None:
            start = curdir
    
        try:
            start_list = [x for x in abspath(start).split(sep) if x]
            path_list = [x for x in abspath(path).split(sep) if x]
            # Work out how much of the filepath is shared by start and path.
            i = len(commonprefix([start_list, path_list]))
    
            rel_list = [pardir] * (len(start_list)-i) + path_list[i:]
            if not rel_list:
                return curdir
            return join(*rel_list)
    
        except (TypeError, AttributeError, BytesWarning, DeprecationWarning):
    
            genericpath._check_arg_types('relpath', path, start)
            raise
    
    
    
    # Return the longest common sub-path of the sequence of paths given as input.
    # The paths are not normalized before comparing them (this is the
    # responsibility of the caller). Any trailing separator is stripped from the
    # returned path.
    
    def commonpath(paths):
        """Given a sequence of path names, returns the longest common sub-path."""
    
        if not paths:
            raise ValueError('commonpath() arg is an empty sequence')
    
    
        paths = tuple(map(os.fspath, paths))
    
        if isinstance(paths[0], bytes):
            sep = b'/'
            curdir = b'.'
        else:
            sep = '/'
            curdir = '.'
    
        try:
            split_paths = [path.split(sep) for path in paths]
    
            try:
                isabs, = set(p[:1] == sep for p in paths)
            except ValueError:
                raise ValueError("Can't mix absolute and relative paths") from None
    
            split_paths = [[c for c in s if c and c != curdir] for s in split_paths]
            s1 = min(split_paths)
            s2 = max(split_paths)
            common = s1
            for i, c in enumerate(s1):
                if c != s2[i]:
                    common = s1[:i]
                    break
    
            prefix = sep if isabs else sep[:0]
            return prefix + sep.join(common)
        except (TypeError, AttributeError):
            genericpath._check_arg_types('commonpath', *paths)
            raise