"""Utility functions for copying and archiving files and directory trees.

XXX The functions here don't copy the resource fork or other metadata on Mac.

"""

import os

import sys

import stat

import fnmatch

import collections

import errno

try:

import zlib

del zlib

_ZLIB_SUPPORTED = True

except ImportError:

_ZLIB_SUPPORTED = False

try:

import bz2

del bz2

_BZ2_SUPPORTED = True

except ImportError:

_BZ2_SUPPORTED = False

try:

import lzma

del lzma

_LZMA_SUPPORTED = True

except ImportError:

_LZMA_SUPPORTED = False

_WINDOWS = os.name == 'nt'

posix = nt = None

if os.name == 'posix':

import posix

elif _WINDOWS:

import nt

if sys.platform == 'win32':

import _winapi

else:

_winapi = None

COPY_BUFSIZE = 1024 * 1024 if _WINDOWS else 64 * 1024

# This should never be removed, see rationale in:

# https://bugs.python.org/issue43743#msg393429

_USE_CP_SENDFILE = hasattr(os, "sendfile") and sys.platform.startswith("linux")

_HAS_FCOPYFILE = posix and hasattr(posix, "_fcopyfile") # macOS

# CMD defaults in Windows 10

_WIN_DEFAULT_PATHEXT = ".COM;.EXE;.BAT;.CMD;.VBS;.JS;.WS;.MSC"

__all__ = ["copyfileobj", "copyfile", "copymode", "copystat", "copy", "copy2",

"copytree", "move", "rmtree", "Error", "SpecialFileError",

"ExecError", "make_archive", "get_archive_formats",

"register_archive_format", "unregister_archive_format",

"get_unpack_formats", "register_unpack_format",

"unregister_unpack_format", "unpack_archive",

"ignore_patterns", "chown", "which", "get_terminal_size",

"SameFileError"]

# disk_usage is added later, if available on the platform

class Error(OSError):

pass

class SameFileError(Error):

"""Raised when source and destination are the same file."""

class SpecialFileError(OSError):

"""Raised when trying to do a kind of operation (e.g. copying) which is

not supported on a special file (e.g. a named pipe)"""

class ExecError(OSError):

"""Raised when a command could not be executed"""

class ReadError(OSError):

"""Raised when an archive cannot be read"""

class RegistryError(Exception):

"""Raised when a registry operation with the archiving

and unpacking registries fails"""

class _GiveupOnFastCopy(Exception):

"""Raised as a signal to fallback on using raw read()/write()

file copy when fast-copy functions fail to do so.

"""

def _fastcopy_fcopyfile(fsrc, fdst, flags):

"""Copy a regular file content or metadata by using high-performance

fcopyfile(3) syscall (macOS).

"""

try:

infd = fsrc.fileno()

outfd = fdst.fileno()

except Exception as err:

raise _GiveupOnFastCopy(err) # not a regular file

try:

posix._fcopyfile(infd, outfd, flags)

except OSError as err:

err.filename = fsrc.name

err.filename2 = fdst.name

if err.errno in {errno.EINVAL, errno.ENOTSUP}:

raise _GiveupOnFastCopy(err)

else:

raise err from None

def _fastcopy_sendfile(fsrc, fdst):

"""Copy data from one regular mmap-like fd to another by using

high-performance sendfile(2) syscall.

This should work on Linux >= 2.6.33 only.

"""

# Note: copyfileobj() is left alone in order to not introduce any

# unexpected breakage. Possible risks by using zero-copy calls

# in copyfileobj() are:

# - fdst cannot be open in "a"(ppend) mode

# - fsrc and fdst may be open in "t"(ext) mode

# - fsrc may be a BufferedReader (which hides unread data in a buffer),

# GzipFile (which decompresses data), HTTPResponse (which decodes

# chunks).

# - possibly others (e.g. encrypted fs/partition?)

global _USE_CP_SENDFILE

try:

infd = fsrc.fileno()

outfd = fdst.fileno()

except Exception as err:

raise _GiveupOnFastCopy(err) # not a regular file

# Hopefully the whole file will be copied in a single call.

# sendfile() is called in a loop 'till EOF is reached (0 return)

# so a bufsize smaller or bigger than the actual file size

# should not make any difference, also in case the file content

# changes while being copied.

try:

blocksize = max(os.fstat(infd).st_size, 2 ** 23) # min 8MiB

except OSError:

blocksize = 2 ** 27 # 128MiB

# On 32-bit architectures truncate to 1GiB to avoid OverflowError,

# see bpo-38319.

if sys.maxsize < 2 ** 32:

blocksize = min(blocksize, 2 ** 30)

offset = 0

while True:

try:

sent = os.sendfile(outfd, infd, offset, blocksize)

except OSError as err:

# ...in oder to have a more informative exception.

err.filename = fsrc.name

err.filename2 = fdst.name

if err.errno == errno.ENOTSOCK:

# sendfile() on this platform (probably Linux < 2.6.33)

# does not support copies between regular files (only

# sockets).

_USE_CP_SENDFILE = False

raise _GiveupOnFastCopy(err)

if err.errno == errno.ENOSPC: # filesystem is full

raise err from None

# Give up on first call and if no data was copied.

if offset == 0 and os.lseek(outfd, 0, os.SEEK_CUR) == 0:

raise _GiveupOnFastCopy(err)

raise err

else:

if sent == 0:

break # EOF

offset += sent

def _copyfileobj_readinto(fsrc, fdst, length=COPY_BUFSIZE):

"""readinto()/memoryview() based variant of copyfileobj().

*fsrc* must support readinto() method and both files must be

open in binary mode.

"""

# Localize variable access to minimize overhead.

fsrc_readinto = fsrc.readinto

fdst_write = fdst.write

with memoryview(bytearray(length)) as mv:

while True:

n = fsrc_readinto(mv)

if not n:

break

elif n < length:

with mv[:n] as smv:

fdst_write(smv)

break

else:

fdst_write(mv)

def copyfileobj(fsrc, fdst, length=0):

"""copy data from file-like object fsrc to file-like object fdst"""

if not length:

length = COPY_BUFSIZE

# Localize variable access to minimize overhead.

fsrc_read = fsrc.read

fdst_write = fdst.write

while buf := fsrc_read(length):

fdst_write(buf)

def _samefile(src, dst):

# Macintosh, Unix.

if isinstance(src, os.DirEntry) and hasattr(os.path, 'samestat'):

try:

return os.path.samestat(src.stat(), os.stat(dst))

except OSError:

return False

if hasattr(os.path, 'samefile'):

try:

return os.path.samefile(src, dst)

except OSError:

return False

# All other platforms: check for same pathname.

return (os.path.normcase(os.path.abspath(src)) ==

os.path.normcase(os.path.abspath(dst)))

def _stat(fn):

return fn.stat() if isinstance(fn, os.DirEntry) else os.stat(fn)

def _islink(fn):

return fn.is_symlink() if isinstance(fn, os.DirEntry) else os.path.islink(fn)

def copyfile(src, dst, *, follow_symlinks=True):

"""Copy data from src to dst in the most efficient way possible.

If follow_symlinks is not set and src is a symbolic link, a new

symlink will be created instead of copying the file it points to.

"""

sys.audit("shutil.copyfile", src, dst)

if _samefile(src, dst):

raise SameFileError("{!r} and {!r} are the same file".format(src, dst))

file_size = 0

for i, fn in enumerate([src, dst]):

try:

st = _stat(fn)

except OSError:

# File most likely does not exist

pass

else:

# XXX What about other special files? (sockets, devices...)

if stat.S_ISFIFO(st.st_mode):

fn = fn.path if isinstance(fn, os.DirEntry) else fn

raise SpecialFileError("`%s` is a named pipe" % fn)

if _WINDOWS and i == 0:

file_size = st.st_size

if not follow_symlinks and _islink(src):

os.symlink(os.readlink(src), dst)

else:

with open(src, 'rb') as fsrc:

try:

with open(dst, 'wb') as fdst:

# macOS

if _HAS_FCOPYFILE:

try:

_fastcopy_fcopyfile(fsrc, fdst, posix._COPYFILE_DATA)

return dst

except _GiveupOnFastCopy:

pass

# Linux

elif _USE_CP_SENDFILE:

try:

_fastcopy_sendfile(fsrc, fdst)

return dst

except _GiveupOnFastCopy:

pass

# Windows, see:

# https://github.com/python/cpython/pull/7160#discussion_r195405230

elif _WINDOWS and file_size > 0:

_copyfileobj_readinto(fsrc, fdst, min(file_size, COPY_BUFSIZE))

return dst

copyfileobj(fsrc, fdst)

# Issue 43219, raise a less confusing exception

except IsADirectoryError as e:

if not os.path.exists(dst):

raise FileNotFoundError(f'Directory does not exist: {dst}') from e

else:

raise

return dst

def copymode(src, dst, *, follow_symlinks=True):

"""Copy mode bits from src to dst.

If follow_symlinks is not set, symlinks aren't followed if and only

if both `src` and `dst` are symlinks. If `lchmod` isn't available

(e.g. Linux) this method does nothing.

"""

sys.audit("shutil.copymode", src, dst)

if not follow_symlinks and _islink(src) and os.path.islink(dst):

if hasattr(os, 'lchmod'):

stat_func, chmod_func = os.lstat, os.lchmod

else:

return

else:

stat_func, chmod_func = _stat, os.chmod

st = stat_func(src)

chmod_func(dst, stat.S_IMODE(st.st_mode))

if hasattr(os, 'listxattr'):

def _copyxattr(src, dst, *, follow_symlinks=True):

"""Copy extended filesystem attributes from `src` to `dst`.

Overwrite existing attributes.

If `follow_symlinks` is false, symlinks won't be followed.

"""

try:

names = os.listxattr(src, follow_symlinks=follow_symlinks)

except OSError as e:

if e.errno not in (errno.ENOTSUP, errno.ENODATA, errno.EINVAL):

raise

return

for name in names:

try:

value = os.getxattr(src, name, follow_symlinks=follow_symlinks)

os.setxattr(dst, name, value, follow_symlinks=follow_symlinks)

except OSError as e:

if e.errno not in (errno.EPERM, errno.ENOTSUP, errno.ENODATA,

errno.EINVAL, errno.EACCES):

raise

else:

def _copyxattr(*args, **kwargs):

pass

def copystat(src, dst, *, follow_symlinks=True):

"""Copy file metadata

Copy the permission bits, last access time, last modification time, and

flags from `src` to `dst`. On Linux, copystat() also copies the "extended

attributes" where possible. The file contents, owner, and group are

unaffected. `src` and `dst` are path-like objects or path names given as

strings.

If the optional flag `follow_symlinks` is not set, symlinks aren't

followed if and only if both `src` and `dst` are symlinks.

"""

sys.audit("shutil.copystat", src, dst)

def _nop(*args, ns=None, follow_symlinks=None):

pass

# follow symlinks (aka don't not follow symlinks)

follow = follow_symlinks or not (_islink(src) and os.path.islink(dst))

if follow:

# use the real function if it exists

def lookup(name):

return getattr(os, name, _nop)

else:

# use the real function only if it exists

# *and* it supports follow_symlinks

def lookup(name):

fn = getattr(os, name, _nop)

if fn in os.supports_follow_symlinks:

return fn

return _nop

if isinstance(src, os.DirEntry):

st = src.stat(follow_symlinks=follow)

else:

st = lookup("stat")(src, follow_symlinks=follow)

mode = stat.S_IMODE(st.st_mode)

lookup("utime")(dst, ns=(st.st_atime_ns, st.st_mtime_ns),

follow_symlinks=follow)

# We must copy extended attributes before the file is (potentially)

# chmod()'ed read-only, otherwise setxattr() will error with -EACCES.

_copyxattr(src, dst, follow_symlinks=follow)

try:

lookup("chmod")(dst, mode, follow_symlinks=follow)

except NotImplementedError:

# if we got a NotImplementedError, it's because

# * follow_symlinks=False,

# * lchown() is unavailable, and

# * either

# * fchownat() is unavailable or

# * fchownat() doesn't implement AT_SYMLINK_NOFOLLOW.

# (it returned ENOSUP.)

# therefore we're out of options--we simply cannot chown the

# symlink. give up, suppress the error.

# (which is what shutil always did in this circumstance.)

pass

if hasattr(st, 'st_flags'):

try:

lookup("chflags")(dst, st.st_flags, follow_symlinks=follow)

except OSError as why:

for err in 'EOPNOTSUPP', 'ENOTSUP':

if hasattr(errno, err) and why.errno == getattr(errno, err):

break

else:

raise

def copy(src, dst, *, follow_symlinks=True):

"""Copy data and mode bits ("cp src dst"). Return the file's destination.

The destination may be a directory.

If follow_symlinks is false, symlinks won't be followed. This

resembles GNU's "cp -P src dst".

If source and destination are the same file, a SameFileError will be

raised.

"""

if os.path.isdir(dst):

dst = os.path.join(dst, os.path.basename(src))

copyfile(src, dst, follow_symlinks=follow_symlinks)

copymode(src, dst, follow_symlinks=follow_symlinks)

return dst

def copy2(src, dst, *, follow_symlinks=True):

"""Copy data and metadata. Return the file's destination.

Metadata is copied with copystat(). Please see the copystat function

for more information.

The destination may be a directory.

If follow_symlinks is false, symlinks won't be followed. This

resembles GNU's "cp -P src dst".

"""

if os.path.isdir(dst):

dst = os.path.join(dst, os.path.basename(src))

if hasattr(_winapi, "CopyFile2"):

src_ = os.fsdecode(src)

dst_ = os.fsdecode(dst)

flags = _winapi.COPY_FILE_ALLOW_DECRYPTED_DESTINATION # for compat

if not follow_symlinks:

flags |= _winapi.COPY_FILE_COPY_SYMLINK

try:

_winapi.CopyFile2(src_, dst_, flags)

return dst

except OSError as exc:

if (exc.winerror == _winapi.ERROR_PRIVILEGE_NOT_HELD

and not follow_symlinks):

# Likely encountered a symlink we aren't allowed to create.

# Fall back on the old code

pass

elif exc.winerror == _winapi.ERROR_ACCESS_DENIED:

# Possibly encountered a hidden or readonly file we can't

# overwrite. Fall back on old code

pass

else:

raise

copyfile(src, dst, follow_symlinks=follow_symlinks)

copystat(src, dst, follow_symlinks=follow_symlinks)

return dst

def ignore_patterns(*patterns):

"""Function that can be used as copytree() ignore parameter.

Patterns is a sequence of glob-style patterns

that are used to exclude files"""

def _ignore_patterns(path, names):

ignored_names = []

for pattern in patterns:

ignored_names.extend(fnmatch.filter(names, pattern))

return set(ignored_names)

return _ignore_patterns

def _copytree(entries, src, dst, symlinks, ignore, copy_function,

ignore_dangling_symlinks, dirs_exist_ok=False):

if ignore is not None:

ignored_names = ignore(os.fspath(src), [x.name for x in entries])

else:

ignored_names = ()

os.makedirs(dst, exist_ok=dirs_exist_ok)

errors = []

use_srcentry = copy_function is copy2 or copy_function is copy

for srcentry in entries:

if srcentry.name in ignored_names:

continue

srcname = os.path.join(src, srcentry.name)

dstname = os.path.join(dst, srcentry.name)

srcobj = srcentry if use_srcentry else srcname

try:

is_symlink = srcentry.is_symlink()

if is_symlink and os.name == 'nt':

# Special check for directory junctions, which appear as

# symlinks but we want to recurse.

lstat = srcentry.stat(follow_symlinks=False)

if lstat.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT:

is_symlink = False

if is_symlink:

linkto = os.readlink(srcname)

if symlinks:

# We can't just leave it to `copy_function` because legacy

# code with a custom `copy_function` may rely on copytree

# doing the right thing.

os.symlink(linkto, dstname)

copystat(srcobj, dstname, follow_symlinks=not symlinks)

else:

# ignore dangling symlink if the flag is on

if not os.path.exists(linkto) and ignore_dangling_symlinks:

continue

# otherwise let the copy occur. copy2 will raise an error

if srcentry.is_dir():

copytree(srcobj, dstname, symlinks, ignore,

copy_function, ignore_dangling_symlinks,

dirs_exist_ok)

else:

copy_function(srcobj, dstname)

elif srcentry.is_dir():

copytree(srcobj, dstname, symlinks, ignore, copy_function,

ignore_dangling_symlinks, dirs_exist_ok)

else:

# Will raise a SpecialFileError for unsupported file types

copy_function(srcobj, dstname)

# catch the Error from the recursive copytree so that we can

# continue with other files

except Error as err:

errors.extend(err.args[0])

except OSError as why:

errors.append((srcname, dstname, str(why)))

try:

copystat(src, dst)

except OSError as why:

# Copying file access times may fail on Windows

if getattr(why, 'winerror', None) is None:

errors.append((src, dst, str(why)))

if errors:

raise Error(errors)

return dst

def copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2,

ignore_dangling_symlinks=False, dirs_exist_ok=False):

"""Recursively copy a directory tree and return the destination directory.

If exception(s) occur, an Error is raised with a list of reasons.

If the optional symlinks flag is true, symbolic links in the

source tree result in symbolic links in the destination tree; if

it is false, the contents of the files pointed to by symbolic

links are copied. If the file pointed by the symlink doesn't

exist, an exception will be added in the list of errors raised in

an Error exception at the end of the copy process.

You can set the optional ignore_dangling_symlinks flag to true if you

want to silence this exception. Notice that this has no effect on

platforms that don't support os.symlink.

The optional ignore argument is a callable. If given, it

is called with the `src` parameter, which is the directory

being visited by copytree(), and `names` which is the list of

`src` contents, as returned by os.listdir():

callable(src, names) -> ignored_names

Since copytree() is called recursively, the callable will be

called once for each directory that is copied. It returns a

list of names relative to the `src` directory that should

not be copied.

The optional copy_function argument is a callable that will be used

to copy each file. It will be called with the source path and the

destination path as arguments. By default, copy2() is used, but any

function that supports the same signature (like copy()) can be used.

If dirs_exist_ok is false (the default) and `dst` already exists, a

`FileExistsError` is raised. If `dirs_exist_ok` is true, the copying

operation will continue if it encounters existing directories, and files

within the `dst` tree will be overwritten by corresponding files from the

`src` tree.

"""

sys.audit("shutil.copytree", src, dst)

with os.scandir(src) as itr:

entries = list(itr)

return _copytree(entries=entries, src=src, dst=dst, symlinks=symlinks,

ignore=ignore, copy_function=copy_function,

ignore_dangling_symlinks=ignore_dangling_symlinks,

dirs_exist_ok=dirs_exist_ok)

if hasattr(os.stat_result, 'st_file_attributes'):

def _rmtree_islink(st):

return (stat.S_ISLNK(st.st_mode) or

(st.st_file_attributes & stat.FILE_ATTRIBUTE_REPARSE_POINT

and st.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT))

else:

def _rmtree_islink(st):

return stat.S_ISLNK(st.st_mode)

# version vulnerable to race conditions

def _rmtree_unsafe(path, onexc):

try:

with os.scandir(path) as scandir_it:

entries = list(scandir_it)

except FileNotFoundError:

return

except OSError as err:

onexc(os.scandir, path, err)

entries = []

for entry in entries:

fullname = entry.path

try:

is_dir = entry.is_dir(follow_symlinks=False)

except FileNotFoundError:

continue

except OSError:

is_dir = False

if is_dir and not entry.is_junction():

try:

if entry.is_symlink():

# This can only happen if someone replaces

# a directory with a symlink after the call to

# os.scandir or entry.is_dir above.

raise OSError("Cannot call rmtree on a symbolic link")

except FileNotFoundError:

continue

except OSError as err:

onexc(os.path.islink, fullname, err)

continue

_rmtree_unsafe(fullname, onexc)

else:

try:

os.unlink(fullname)

except FileNotFoundError:

continue

except OSError as err:

onexc(os.unlink, fullname, err)

try:

os.rmdir(path)

except FileNotFoundError:

pass

except OSError as err:

onexc(os.rmdir, path, err)

# Version using fd-based APIs to protect against races

def _rmtree_safe_fd(topfd, path, onexc):

try:

with os.scandir(topfd) as scandir_it:

entries = list(scandir_it)

except FileNotFoundError:

return

except OSError as err:

err.filename = path

onexc(os.scandir, path, err)

return

for entry in entries:

fullname = os.path.join(path, entry.name)

try:

is_dir = entry.is_dir(follow_symlinks=False)

except FileNotFoundError:

continue

except OSError:

is_dir = False

else:

if is_dir:

try:

orig_st = entry.stat(follow_symlinks=False)

is_dir = stat.S_ISDIR(orig_st.st_mode)

except FileNotFoundError:

continue

except OSError as err:

onexc(os.lstat, fullname, err)

continue

if is_dir:

try:

dirfd = os.open(entry.name, os.O_RDONLY, dir_fd=topfd)

dirfd_closed = False

except FileNotFoundError:

continue

except OSError as err:

onexc(os.open, fullname, err)

else:

try:

if os.path.samestat(orig_st, os.fstat(dirfd)):

_rmtree_safe_fd(dirfd, fullname, onexc)

try:

os.close(dirfd)

dirfd_closed = True

os.rmdir(entry.name, dir_fd=topfd)

except FileNotFoundError:

continue

except OSError as err:

onexc(os.rmdir, fullname, err)

else:

try:

# This can only happen if someone replaces

# a directory with a symlink after the call to

# os.scandir or stat.S_ISDIR above.

raise OSError("Cannot call rmtree on a symbolic "

"link")

except OSError as err:

onexc(os.path.islink, fullname, err)

finally:

if not dirfd_closed:

os.close(dirfd)

else:

try:

os.unlink(entry.name, dir_fd=topfd)

except FileNotFoundError:

continue

except OSError as err:

onexc(os.unlink, fullname, err)

_use_fd_functions = ({os.open, os.stat, os.unlink, os.rmdir} <=

os.supports_dir_fd and

os.scandir in os.supports_fd and

os.stat in os.supports_follow_symlinks)

def rmtree(path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None):

"""Recursively delete a directory tree.

If dir_fd is not None, it should be a file descriptor open to a directory;

path will then be relative to that directory.

dir_fd may not be implemented on your platform.

If it is unavailable, using it will raise a NotImplementedError.

If ignore_errors is set, errors are ignored; otherwise, if onexc or

onerror is set, it is called to handle the error with arguments (func,

path, exc_info) where func is platform and implementation dependent;

path is the argument to that function that caused it to fail; and

the value of exc_info describes the exception. For onexc it is the

exception instance, and for onerror it is a tuple as returned by

sys.exc_info(). If ignore_errors is false and both onexc and

onerror are None, the exception is reraised.

onerror is deprecated and only remains for backwards compatibility.

If both onerror and onexc are set, onerror is ignored and onexc is used.

"""

sys.audit("shutil.rmtree", path, dir_fd)

if ignore_errors:

def onexc(*args):

pass

elif onerror is None and onexc is None:

def onexc(*args):

raise

elif onexc is None:

if onerror is None:

def onexc(*args):

raise

else:

# delegate to onerror

def onexc(*args):

func, path, exc = args

if exc is None:

exc_info = None, None, None

else:

exc_info = type(exc), exc, exc.__traceback__

return onerror(func, path, exc_info)

if _use_fd_functions:

# While the unsafe rmtree works fine on bytes, the fd based does not.

if isinstance(path, bytes):

path = os.fsdecode(path)

# Note: To guard against symlink races, we use the standard

# lstat()/open()/fstat() trick.

try:

orig_st = os.lstat(path, dir_fd=dir_fd)

except OSError as err:

onexc(os.lstat, path, err)

return

try:

fd = os.open(path, os.O_RDONLY, dir_fd=dir_fd)

fd_closed = False

except OSError as err:

onexc(os.open, path, err)

return

try:

if os.path.samestat(orig_st, os.fstat(fd)):

_rmtree_safe_fd(fd, path, onexc)

try:

os.close(fd)

fd_closed = True

os.rmdir(path, dir_fd=dir_fd)

except OSError as err:

onexc(os.rmdir, path, err)

else:

try:

# symlinks to directories are forbidden, see bug #1669

raise OSError("Cannot call rmtree on a symbolic link")

except OSError as err:

onexc(os.path.islink, path, err)

finally:

if not fd_closed:

os.close(fd)

else:

if dir_fd is not None:

raise NotImplementedError("dir_fd unavailable on this platform")

try:

st = os.lstat(path)

except OSError as err:

onexc(os.lstat, path, err)

return

try:

if _rmtree_islink(st):

# symlinks to directories are forbidden, see bug #1669

raise OSError("Cannot call rmtree on a symbolic link")

except OSError as err:

onexc(os.path.islink, path, err)

# can't continue even if onexc hook returns

return

return _rmtree_unsafe(path, onexc)

# Allow introspection of whether or not the hardening against symlink

# attacks is supported on the current platform

rmtree.avoids_symlink_attacks = _use_fd_functions

def _basename(path):

"""A basename() variant which first strips the trailing slash, if present.

Thus we always get the last component of the path, even for directories.

path: Union[PathLike, str]

e.g.

>>> os.path.basename('/bar/foo')

'foo'

>>> os.path.basename('/bar/foo/')

''

>>> _basename('/bar/foo/')

'foo'

"""

path = os.fspath(path)

sep = os.path.sep + (os.path.altsep or '')

return os.path.basename(path.rstrip(sep))

def move(src, dst, copy_function=copy2):

"""Recursively move a file or directory to another location. This is

similar to the Unix "mv" command. Return the file or directory's

destination.

If the destination is a directory or a symlink to a directory, the source

is moved inside the directory. The destination path must not already

exist.

If the destination already exists but is not a directory, it may be

overwritten depending on os.rename() semantics.

If the destination is on our current filesystem, then rename() is used.

Otherwise, src is copied to the destination and then removed. Symlinks are

recreated under the new name if os.rename() fails because of cross

filesystem renames.

The optional `copy_function` argument is a callable that will be used

to copy the source or it will be delegated to `copytree`.

By default, copy2() is used, but any function that supports the same

signature (like copy()) can be used.

A lot more could be done here... A look at a mv.c shows a lot of

the issues this implementation glosses over.

"""

sys.audit("shutil.move", src, dst)

real_dst = dst

if os.path.isdir(dst):

if _samefile(src, dst):

# We might be on a case insensitive filesystem,

# perform the rename anyway.

os.rename(src, dst)

return

# Using _basename instead of os.path.basename is important, as we must

# ignore any trailing slash to avoid the basename returning ''

real_dst = os.path.join(dst, _basename(src))

if os.path.exists(real_dst):

raise Error("Destination path '%s' already exists" % real_dst)

try:

os.rename(src, real_dst)

except OSError:

if os.path.islink(src):

linkto = os.readlink(src)

os.symlink(linkto, real_dst)

os.unlink(src)

elif os.path.isdir(src):

if _destinsrc(src, dst):

raise Error("Cannot move a directory '%s' into itself"

" '%s'." % (src, dst))

if (_is_immutable(src)

or (not os.access(src, os.W_OK) and os.listdir(src)

and sys.platform == 'darwin')):

raise PermissionError("Cannot move the non-empty directory "

"'%s': Lacking write permission to '%s'."

% (src, src))

copytree(src, real_dst, copy_function=copy_function,

symlinks=True)

rmtree(src)

else:

copy_function(src, real_dst)

os.unlink(src)

return real_dst

def _destinsrc(src, dst):

src = os.path.abspath(src)

dst = os.path.abspath(dst)

if not src.endswith(os.path.sep):

src += os.path.sep

if not dst.endswith(os.path.sep):

dst += os.path.sep

return dst.startswith(src)

def _is_immutable(src):

st = _stat(src)

immutable_states = [stat.UF_IMMUTABLE, stat.SF_IMMUTABLE]

return hasattr(st, 'st_flags') and st.st_flags in immutable_states

def _get_gid(name):

"""Returns a gid, given a group name."""

if name is None:

return None

try:

from grp import getgrnam

except ImportError:

return None

try:

result = getgrnam(name)

except KeyError:

result = None

if result is not None:

return result[2]

return None

def _get_uid(name):

"""Returns an uid, given a user name."""

if name is None:

return None

try:

from pwd import getpwnam

except ImportError:

return None

try:

result = getpwnam(name)

except KeyError:

result = None

if result is not None:

return result[2]

return None

def _make_tarball(base_name, base_dir, compress="gzip", verbose=0, dry_run=0,

owner=None, group=None, logger=None, root_dir=None):

"""Create a (possibly compressed) tar file from all the files under

'base_dir'.

'compress' must be "gzip" (the default), "bzip2", "xz", or None.

'owner' and 'group' can be used to define an owner and a group for the

archive that is being built. If not provided, the current owner and group

will be used.

The output tar file will be named 'base_name' + ".tar", possibly plus

the appropriate compression extension (".gz", ".bz2", or ".xz").

Returns the output filename.

"""

if compress is None:

tar_compression = ''

elif _ZLIB_SUPPORTED and compress == 'gzip':

tar_compression = 'gz'

elif _BZ2_SUPPORTED and compress == 'bzip2':

tar_compression = 'bz2'

elif _LZMA_SUPPORTED and compress == 'xz':

tar_compression = 'xz'

else:

raise ValueError("bad value for 'compress', or compression format not "

"supported : {0}".format(compress))

import tarfile # late import for breaking circular dependency

compress_ext = '.' + tar_compression if compress else ''

archive_name = base_name + '.tar' + compress_ext

archive_dir = os.path.dirname(archive_name)

if archive_dir and not os.path.exists(archive_dir):

if logger is not None:

logger.info("creating %s", archive_dir)

if not dry_run:

os.makedirs(archive_dir)

# creating the tarball

if logger is not None:

logger.info('Creating tar archive')

uid = _get_uid(owner)

gid = _get_gid(group)