Tarek Ziadé | c339978 | 2010-02-23 05:39:18 +0000 | [diff] [blame] | 1 | """Utility functions for copying and archiving files and directory trees. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | 959fa01 | 1999-08-18 20:03:17 +0000 | [diff] [blame] | 3 | XXX The functions here don't copy the resource fork or other metadata on Mac. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 4 | |
| 5 | """ |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 6 | |
Guido van Rossum | c96207a | 1992-03-31 18:55:40 +0000 | [diff] [blame] | 7 | import os |
Guido van Rossum | 83c03e2 | 1999-02-23 23:07:51 +0000 | [diff] [blame] | 8 | import sys |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 9 | import stat |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 10 | import fnmatch |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 11 | import collections |
Antoine Pitrou | 910bd51 | 2010-03-22 20:11:09 +0000 | [diff] [blame] | 12 | import errno |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 13 | |
| 14 | try: |
| 15 | import zlib |
| 16 | del zlib |
| 17 | _ZLIB_SUPPORTED = True |
| 18 | except ImportError: |
| 19 | _ZLIB_SUPPORTED = False |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 20 | |
| 21 | try: |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 22 | import bz2 |
Florent Xicluna | 54540ec | 2011-11-04 08:29:17 +0100 | [diff] [blame] | 23 | del bz2 |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 24 | _BZ2_SUPPORTED = True |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 25 | except ImportError: |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 26 | _BZ2_SUPPORTED = False |
| 27 | |
| 28 | try: |
Serhiy Storchaka | 1121377 | 2014-08-06 18:50:19 +0300 | [diff] [blame] | 29 | import lzma |
| 30 | del lzma |
| 31 | _LZMA_SUPPORTED = True |
| 32 | except ImportError: |
| 33 | _LZMA_SUPPORTED = False |
| 34 | |
| 35 | try: |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 36 | from pwd import getpwnam |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 37 | except ImportError: |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 38 | getpwnam = None |
| 39 | |
| 40 | try: |
| 41 | from grp import getgrnam |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 42 | except ImportError: |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 43 | getgrnam = None |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 44 | |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 45 | _WINDOWS = os.name == 'nt' |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 46 | posix = nt = None |
| 47 | if os.name == 'posix': |
| 48 | import posix |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 49 | elif _WINDOWS: |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 50 | import nt |
| 51 | |
Inada Naoki | 4f19030 | 2019-03-02 13:31:01 +0900 | [diff] [blame] | 52 | COPY_BUFSIZE = 1024 * 1024 if _WINDOWS else 64 * 1024 |
Giampaolo Rodola | 413d955 | 2019-05-30 14:05:41 +0800 | [diff] [blame] | 53 | _USE_CP_SENDFILE = hasattr(os, "sendfile") and sys.platform.startswith("linux") |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 54 | _HAS_FCOPYFILE = posix and hasattr(posix, "_fcopyfile") # macOS |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 55 | |
Christopher Marchfelder | da6f098 | 2020-10-23 12:08:24 +0200 | [diff] [blame] | 56 | # CMD defaults in Windows 10 |
| 57 | _WIN_DEFAULT_PATHEXT = ".COM;.EXE;.BAT;.CMD;.VBS;.JS;.WS;.MSC" |
| 58 | |
Tarek Ziadé | c339978 | 2010-02-23 05:39:18 +0000 | [diff] [blame] | 59 | __all__ = ["copyfileobj", "copyfile", "copymode", "copystat", "copy", "copy2", |
| 60 | "copytree", "move", "rmtree", "Error", "SpecialFileError", |
| 61 | "ExecError", "make_archive", "get_archive_formats", |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 62 | "register_archive_format", "unregister_archive_format", |
| 63 | "get_unpack_formats", "register_unpack_format", |
Éric Araujo | c5efe65 | 2011-08-21 14:30:00 +0200 | [diff] [blame] | 64 | "unregister_unpack_format", "unpack_archive", |
Berker Peksag | 8083cd6 | 2014-11-01 11:04:06 +0200 | [diff] [blame] | 65 | "ignore_patterns", "chown", "which", "get_terminal_size", |
| 66 | "SameFileError"] |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 67 | # disk_usage is added later, if available on the platform |
Martin v. Löwis | e9ce0b0 | 2002-10-07 13:23:24 +0000 | [diff] [blame] | 68 | |
Andrew Svetlov | 3438fa4 | 2012-12-17 23:35:18 +0200 | [diff] [blame] | 69 | class Error(OSError): |
Martin v. Löwis | e9ce0b0 | 2002-10-07 13:23:24 +0000 | [diff] [blame] | 70 | pass |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 71 | |
Hynek Schlawack | 4865376 | 2012-10-07 12:49:58 +0200 | [diff] [blame] | 72 | class SameFileError(Error): |
| 73 | """Raised when source and destination are the same file.""" |
| 74 | |
Andrew Svetlov | 3438fa4 | 2012-12-17 23:35:18 +0200 | [diff] [blame] | 75 | class SpecialFileError(OSError): |
Antoine Pitrou | 7fff096 | 2009-05-01 21:09:44 +0000 | [diff] [blame] | 76 | """Raised when trying to do a kind of operation (e.g. copying) which is |
| 77 | not supported on a special file (e.g. a named pipe)""" |
| 78 | |
Andrew Svetlov | 3438fa4 | 2012-12-17 23:35:18 +0200 | [diff] [blame] | 79 | class ExecError(OSError): |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 80 | """Raised when a command could not be executed""" |
| 81 | |
Andrew Svetlov | 3438fa4 | 2012-12-17 23:35:18 +0200 | [diff] [blame] | 82 | class ReadError(OSError): |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 83 | """Raised when an archive cannot be read""" |
| 84 | |
| 85 | class RegistryError(Exception): |
Ezio Melotti | 30b9d5d | 2013-08-17 15:50:46 +0300 | [diff] [blame] | 86 | """Raised when a registry operation with the archiving |
Raymond Hettinger | 15f44ab | 2016-08-30 10:47:49 -0700 | [diff] [blame] | 87 | and unpacking registries fails""" |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 88 | |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 89 | class _GiveupOnFastCopy(Exception): |
| 90 | """Raised as a signal to fallback on using raw read()/write() |
| 91 | file copy when fast-copy functions fail to do so. |
| 92 | """ |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 93 | |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 94 | def _fastcopy_fcopyfile(fsrc, fdst, flags): |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 95 | """Copy a regular file content or metadata by using high-performance |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 96 | fcopyfile(3) syscall (macOS). |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 97 | """ |
| 98 | try: |
| 99 | infd = fsrc.fileno() |
| 100 | outfd = fdst.fileno() |
| 101 | except Exception as err: |
| 102 | raise _GiveupOnFastCopy(err) # not a regular file |
| 103 | |
| 104 | try: |
| 105 | posix._fcopyfile(infd, outfd, flags) |
| 106 | except OSError as err: |
| 107 | err.filename = fsrc.name |
| 108 | err.filename2 = fdst.name |
| 109 | if err.errno in {errno.EINVAL, errno.ENOTSUP}: |
| 110 | raise _GiveupOnFastCopy(err) |
| 111 | else: |
| 112 | raise err from None |
| 113 | |
| 114 | def _fastcopy_sendfile(fsrc, fdst): |
| 115 | """Copy data from one regular mmap-like fd to another by using |
| 116 | high-performance sendfile(2) syscall. |
Giampaolo Rodola | 413d955 | 2019-05-30 14:05:41 +0800 | [diff] [blame] | 117 | This should work on Linux >= 2.6.33 only. |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 118 | """ |
| 119 | # Note: copyfileobj() is left alone in order to not introduce any |
| 120 | # unexpected breakage. Possible risks by using zero-copy calls |
| 121 | # in copyfileobj() are: |
| 122 | # - fdst cannot be open in "a"(ppend) mode |
| 123 | # - fsrc and fdst may be open in "t"(ext) mode |
| 124 | # - fsrc may be a BufferedReader (which hides unread data in a buffer), |
| 125 | # GzipFile (which decompresses data), HTTPResponse (which decodes |
| 126 | # chunks). |
| 127 | # - possibly others (e.g. encrypted fs/partition?) |
Giampaolo Rodola | 413d955 | 2019-05-30 14:05:41 +0800 | [diff] [blame] | 128 | global _USE_CP_SENDFILE |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 129 | try: |
| 130 | infd = fsrc.fileno() |
| 131 | outfd = fdst.fileno() |
| 132 | except Exception as err: |
| 133 | raise _GiveupOnFastCopy(err) # not a regular file |
| 134 | |
| 135 | # Hopefully the whole file will be copied in a single call. |
| 136 | # sendfile() is called in a loop 'till EOF is reached (0 return) |
| 137 | # so a bufsize smaller or bigger than the actual file size |
| 138 | # should not make any difference, also in case the file content |
| 139 | # changes while being copied. |
| 140 | try: |
Giampaolo Rodola | 94e1650 | 2019-10-01 11:40:54 +0800 | [diff] [blame] | 141 | blocksize = max(os.fstat(infd).st_size, 2 ** 23) # min 8MiB |
| 142 | except OSError: |
| 143 | blocksize = 2 ** 27 # 128MiB |
| 144 | # On 32-bit architectures truncate to 1GiB to avoid OverflowError, |
| 145 | # see bpo-38319. |
| 146 | if sys.maxsize < 2 ** 32: |
| 147 | blocksize = min(blocksize, 2 ** 30) |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 148 | |
| 149 | offset = 0 |
| 150 | while True: |
| 151 | try: |
| 152 | sent = os.sendfile(outfd, infd, offset, blocksize) |
| 153 | except OSError as err: |
| 154 | # ...in oder to have a more informative exception. |
| 155 | err.filename = fsrc.name |
| 156 | err.filename2 = fdst.name |
| 157 | |
| 158 | if err.errno == errno.ENOTSOCK: |
| 159 | # sendfile() on this platform (probably Linux < 2.6.33) |
| 160 | # does not support copies between regular files (only |
| 161 | # sockets). |
Giampaolo Rodola | 413d955 | 2019-05-30 14:05:41 +0800 | [diff] [blame] | 162 | _USE_CP_SENDFILE = False |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 163 | raise _GiveupOnFastCopy(err) |
| 164 | |
| 165 | if err.errno == errno.ENOSPC: # filesystem is full |
| 166 | raise err from None |
| 167 | |
| 168 | # Give up on first call and if no data was copied. |
| 169 | if offset == 0 and os.lseek(outfd, 0, os.SEEK_CUR) == 0: |
| 170 | raise _GiveupOnFastCopy(err) |
| 171 | |
| 172 | raise err |
| 173 | else: |
| 174 | if sent == 0: |
| 175 | break # EOF |
| 176 | offset += sent |
| 177 | |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 178 | def _copyfileobj_readinto(fsrc, fdst, length=COPY_BUFSIZE): |
| 179 | """readinto()/memoryview() based variant of copyfileobj(). |
| 180 | *fsrc* must support readinto() method and both files must be |
| 181 | open in binary mode. |
| 182 | """ |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 183 | # Localize variable access to minimize overhead. |
| 184 | fsrc_readinto = fsrc.readinto |
| 185 | fdst_write = fdst.write |
| 186 | with memoryview(bytearray(length)) as mv: |
| 187 | while True: |
| 188 | n = fsrc_readinto(mv) |
| 189 | if not n: |
| 190 | break |
| 191 | elif n < length: |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 192 | with mv[:n] as smv: |
| 193 | fdst.write(smv) |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 194 | else: |
| 195 | fdst_write(mv) |
| 196 | |
Giampaolo Rodola | 3b0abb0 | 2019-02-24 15:46:40 -0800 | [diff] [blame] | 197 | def copyfileobj(fsrc, fdst, length=0): |
Greg Stein | 42bb8b3 | 2000-07-12 09:55:30 +0000 | [diff] [blame] | 198 | """copy data from file-like object fsrc to file-like object fdst""" |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 199 | # Localize variable access to minimize overhead. |
Giampaolo Rodola | 3b0abb0 | 2019-02-24 15:46:40 -0800 | [diff] [blame] | 200 | if not length: |
| 201 | length = COPY_BUFSIZE |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 202 | fsrc_read = fsrc.read |
| 203 | fdst_write = fdst.write |
| 204 | while True: |
| 205 | buf = fsrc_read(length) |
| 206 | if not buf: |
| 207 | break |
| 208 | fdst_write(buf) |
Greg Stein | 42bb8b3 | 2000-07-12 09:55:30 +0000 | [diff] [blame] | 209 | |
Johannes Gijsbers | 46f1459 | 2004-08-14 13:30:02 +0000 | [diff] [blame] | 210 | def _samefile(src, dst): |
| 211 | # Macintosh, Unix. |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 212 | if isinstance(src, os.DirEntry) and hasattr(os.path, 'samestat'): |
| 213 | try: |
| 214 | return os.path.samestat(src.stat(), os.stat(dst)) |
| 215 | except OSError: |
| 216 | return False |
| 217 | |
Tarek Ziadé | 1eab9cc | 2010-04-19 21:19:57 +0000 | [diff] [blame] | 218 | if hasattr(os.path, 'samefile'): |
Johannes Gijsbers | f9a098e | 2004-08-14 14:51:01 +0000 | [diff] [blame] | 219 | try: |
| 220 | return os.path.samefile(src, dst) |
| 221 | except OSError: |
| 222 | return False |
Johannes Gijsbers | 46f1459 | 2004-08-14 13:30:02 +0000 | [diff] [blame] | 223 | |
| 224 | # All other platforms: check for same pathname. |
| 225 | return (os.path.normcase(os.path.abspath(src)) == |
| 226 | os.path.normcase(os.path.abspath(dst))) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 227 | |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 228 | def _stat(fn): |
| 229 | return fn.stat() if isinstance(fn, os.DirEntry) else os.stat(fn) |
| 230 | |
| 231 | def _islink(fn): |
| 232 | return fn.is_symlink() if isinstance(fn, os.DirEntry) else os.path.islink(fn) |
| 233 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 234 | def copyfile(src, dst, *, follow_symlinks=True): |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 235 | """Copy data from src to dst in the most efficient way possible. |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 236 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 237 | If follow_symlinks is not set and src is a symbolic link, a new |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 238 | symlink will be created instead of copying the file it points to. |
| 239 | |
| 240 | """ |
Saiyang Gou | 7514f4f | 2020-02-12 23:47:42 -0800 | [diff] [blame] | 241 | sys.audit("shutil.copyfile", src, dst) |
| 242 | |
Johannes Gijsbers | 46f1459 | 2004-08-14 13:30:02 +0000 | [diff] [blame] | 243 | if _samefile(src, dst): |
Hynek Schlawack | 4865376 | 2012-10-07 12:49:58 +0200 | [diff] [blame] | 244 | raise SameFileError("{!r} and {!r} are the same file".format(src, dst)) |
Johannes Gijsbers | 46f1459 | 2004-08-14 13:30:02 +0000 | [diff] [blame] | 245 | |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 246 | file_size = 0 |
| 247 | for i, fn in enumerate([src, dst]): |
Antoine Pitrou | 7fff096 | 2009-05-01 21:09:44 +0000 | [diff] [blame] | 248 | try: |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 249 | st = _stat(fn) |
Antoine Pitrou | 7fff096 | 2009-05-01 21:09:44 +0000 | [diff] [blame] | 250 | except OSError: |
| 251 | # File most likely does not exist |
| 252 | pass |
Benjamin Peterson | c0d98aa | 2009-06-05 19:13:27 +0000 | [diff] [blame] | 253 | else: |
| 254 | # XXX What about other special files? (sockets, devices...) |
| 255 | if stat.S_ISFIFO(st.st_mode): |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 256 | fn = fn.path if isinstance(fn, os.DirEntry) else fn |
Benjamin Peterson | c0d98aa | 2009-06-05 19:13:27 +0000 | [diff] [blame] | 257 | raise SpecialFileError("`%s` is a named pipe" % fn) |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 258 | if _WINDOWS and i == 0: |
| 259 | file_size = st.st_size |
Tarek Ziadé | b01142b | 2010-05-05 22:43:04 +0000 | [diff] [blame] | 260 | |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 261 | if not follow_symlinks and _islink(src): |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 262 | os.symlink(os.readlink(src), dst) |
| 263 | else: |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 264 | with open(src, 'rb') as fsrc, open(dst, 'wb') as fdst: |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 265 | # macOS |
| 266 | if _HAS_FCOPYFILE: |
| 267 | try: |
| 268 | _fastcopy_fcopyfile(fsrc, fdst, posix._COPYFILE_DATA) |
| 269 | return dst |
| 270 | except _GiveupOnFastCopy: |
| 271 | pass |
Giampaolo Rodola | 413d955 | 2019-05-30 14:05:41 +0800 | [diff] [blame] | 272 | # Linux |
| 273 | elif _USE_CP_SENDFILE: |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 274 | try: |
| 275 | _fastcopy_sendfile(fsrc, fdst) |
| 276 | return dst |
| 277 | except _GiveupOnFastCopy: |
| 278 | pass |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 279 | # Windows, see: |
| 280 | # https://github.com/python/cpython/pull/7160#discussion_r195405230 |
| 281 | elif _WINDOWS and file_size > 0: |
| 282 | _copyfileobj_readinto(fsrc, fdst, min(file_size, COPY_BUFSIZE)) |
| 283 | return dst |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 284 | |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 285 | copyfileobj(fsrc, fdst) |
Giampaolo Rodola | 4a172cc | 2018-06-12 23:04:50 +0200 | [diff] [blame] | 286 | |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 287 | return dst |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 288 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 289 | def copymode(src, dst, *, follow_symlinks=True): |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 290 | """Copy mode bits from src to dst. |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 291 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 292 | If follow_symlinks is not set, symlinks aren't followed if and only |
| 293 | if both `src` and `dst` are symlinks. If `lchmod` isn't available |
| 294 | (e.g. Linux) this method does nothing. |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 295 | |
| 296 | """ |
Saiyang Gou | 7514f4f | 2020-02-12 23:47:42 -0800 | [diff] [blame] | 297 | sys.audit("shutil.copymode", src, dst) |
| 298 | |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 299 | if not follow_symlinks and _islink(src) and os.path.islink(dst): |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 300 | if hasattr(os, 'lchmod'): |
| 301 | stat_func, chmod_func = os.lstat, os.lchmod |
| 302 | else: |
| 303 | return |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 304 | else: |
Anthony Sottile | 8377cd4 | 2019-02-25 14:32:27 -0800 | [diff] [blame] | 305 | stat_func, chmod_func = _stat, os.chmod |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 306 | |
| 307 | st = stat_func(src) |
| 308 | chmod_func(dst, stat.S_IMODE(st.st_mode)) |
| 309 | |
Larry Hastings | ad5ae04 | 2012-07-14 17:55:11 -0700 | [diff] [blame] | 310 | if hasattr(os, 'listxattr'): |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 311 | def _copyxattr(src, dst, *, follow_symlinks=True): |
Larry Hastings | ad5ae04 | 2012-07-14 17:55:11 -0700 | [diff] [blame] | 312 | """Copy extended filesystem attributes from `src` to `dst`. |
| 313 | |
| 314 | Overwrite existing attributes. |
| 315 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 316 | If `follow_symlinks` is false, symlinks won't be followed. |
Larry Hastings | ad5ae04 | 2012-07-14 17:55:11 -0700 | [diff] [blame] | 317 | |
| 318 | """ |
| 319 | |
Hynek Schlawack | 0beab05 | 2013-02-05 08:22:44 +0100 | [diff] [blame] | 320 | try: |
| 321 | names = os.listxattr(src, follow_symlinks=follow_symlinks) |
| 322 | except OSError as e: |
Ying Wang | a16387a | 2019-05-29 23:25:31 -0400 | [diff] [blame] | 323 | if e.errno not in (errno.ENOTSUP, errno.ENODATA, errno.EINVAL): |
Hynek Schlawack | 0beab05 | 2013-02-05 08:22:44 +0100 | [diff] [blame] | 324 | raise |
| 325 | return |
| 326 | for name in names: |
Larry Hastings | ad5ae04 | 2012-07-14 17:55:11 -0700 | [diff] [blame] | 327 | try: |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 328 | value = os.getxattr(src, name, follow_symlinks=follow_symlinks) |
| 329 | os.setxattr(dst, name, value, follow_symlinks=follow_symlinks) |
Larry Hastings | ad5ae04 | 2012-07-14 17:55:11 -0700 | [diff] [blame] | 330 | except OSError as e: |
Ying Wang | a16387a | 2019-05-29 23:25:31 -0400 | [diff] [blame] | 331 | if e.errno not in (errno.EPERM, errno.ENOTSUP, errno.ENODATA, |
| 332 | errno.EINVAL): |
Larry Hastings | ad5ae04 | 2012-07-14 17:55:11 -0700 | [diff] [blame] | 333 | raise |
| 334 | else: |
| 335 | def _copyxattr(*args, **kwargs): |
| 336 | pass |
| 337 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 338 | def copystat(src, dst, *, follow_symlinks=True): |
Zsolt Cserna | 4f399be | 2018-10-23 12:09:50 +0200 | [diff] [blame] | 339 | """Copy file metadata |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 340 | |
Zsolt Cserna | 4f399be | 2018-10-23 12:09:50 +0200 | [diff] [blame] | 341 | Copy the permission bits, last access time, last modification time, and |
| 342 | flags from `src` to `dst`. On Linux, copystat() also copies the "extended |
| 343 | attributes" where possible. The file contents, owner, and group are |
Boris Verhovsky | 9488a52 | 2019-09-09 09:51:56 -0600 | [diff] [blame] | 344 | unaffected. `src` and `dst` are path-like objects or path names given as |
| 345 | strings. |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 346 | |
Zsolt Cserna | 4f399be | 2018-10-23 12:09:50 +0200 | [diff] [blame] | 347 | If the optional flag `follow_symlinks` is not set, symlinks aren't |
| 348 | followed if and only if both `src` and `dst` are symlinks. |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 349 | """ |
Saiyang Gou | 7514f4f | 2020-02-12 23:47:42 -0800 | [diff] [blame] | 350 | sys.audit("shutil.copystat", src, dst) |
| 351 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 352 | def _nop(*args, ns=None, follow_symlinks=None): |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 353 | pass |
| 354 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 355 | # follow symlinks (aka don't not follow symlinks) |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 356 | follow = follow_symlinks or not (_islink(src) and os.path.islink(dst)) |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 357 | if follow: |
| 358 | # use the real function if it exists |
| 359 | def lookup(name): |
| 360 | return getattr(os, name, _nop) |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 361 | else: |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 362 | # use the real function only if it exists |
| 363 | # *and* it supports follow_symlinks |
| 364 | def lookup(name): |
| 365 | fn = getattr(os, name, _nop) |
| 366 | if fn in os.supports_follow_symlinks: |
| 367 | return fn |
| 368 | return _nop |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 369 | |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 370 | if isinstance(src, os.DirEntry): |
| 371 | st = src.stat(follow_symlinks=follow) |
| 372 | else: |
| 373 | st = lookup("stat")(src, follow_symlinks=follow) |
Walter Dörwald | 294bbf3 | 2002-06-06 09:48:13 +0000 | [diff] [blame] | 374 | mode = stat.S_IMODE(st.st_mode) |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 375 | lookup("utime")(dst, ns=(st.st_atime_ns, st.st_mtime_ns), |
| 376 | follow_symlinks=follow) |
Olexa Bilaniuk | 79efbb7 | 2019-05-09 22:22:06 -0500 | [diff] [blame] | 377 | # We must copy extended attributes before the file is (potentially) |
| 378 | # chmod()'ed read-only, otherwise setxattr() will error with -EACCES. |
| 379 | _copyxattr(src, dst, follow_symlinks=follow) |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 380 | try: |
| 381 | lookup("chmod")(dst, mode, follow_symlinks=follow) |
| 382 | except NotImplementedError: |
| 383 | # if we got a NotImplementedError, it's because |
| 384 | # * follow_symlinks=False, |
| 385 | # * lchown() is unavailable, and |
| 386 | # * either |
Ezio Melotti | 30b9d5d | 2013-08-17 15:50:46 +0300 | [diff] [blame] | 387 | # * fchownat() is unavailable or |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 388 | # * fchownat() doesn't implement AT_SYMLINK_NOFOLLOW. |
| 389 | # (it returned ENOSUP.) |
| 390 | # therefore we're out of options--we simply cannot chown the |
| 391 | # symlink. give up, suppress the error. |
| 392 | # (which is what shutil always did in this circumstance.) |
| 393 | pass |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 394 | if hasattr(st, 'st_flags'): |
Antoine Pitrou | 910bd51 | 2010-03-22 20:11:09 +0000 | [diff] [blame] | 395 | try: |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 396 | lookup("chflags")(dst, st.st_flags, follow_symlinks=follow) |
Antoine Pitrou | 910bd51 | 2010-03-22 20:11:09 +0000 | [diff] [blame] | 397 | except OSError as why: |
Ned Deily | baf7571 | 2012-05-10 17:05:19 -0700 | [diff] [blame] | 398 | for err in 'EOPNOTSUPP', 'ENOTSUP': |
| 399 | if hasattr(errno, err) and why.errno == getattr(errno, err): |
| 400 | break |
| 401 | else: |
Antoine Pitrou | 910bd51 | 2010-03-22 20:11:09 +0000 | [diff] [blame] | 402 | raise |
Antoine Pitrou | 424246f | 2012-05-12 19:02:01 +0200 | [diff] [blame] | 403 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 404 | def copy(src, dst, *, follow_symlinks=True): |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 405 | """Copy data and mode bits ("cp src dst"). Return the file's destination. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 406 | |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 407 | The destination may be a directory. |
| 408 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 409 | If follow_symlinks is false, symlinks won't be followed. This |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 410 | resembles GNU's "cp -P src dst". |
| 411 | |
Hynek Schlawack | 4865376 | 2012-10-07 12:49:58 +0200 | [diff] [blame] | 412 | If source and destination are the same file, a SameFileError will be |
| 413 | raised. |
| 414 | |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 415 | """ |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 416 | if os.path.isdir(dst): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 417 | dst = os.path.join(dst, os.path.basename(src)) |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 418 | copyfile(src, dst, follow_symlinks=follow_symlinks) |
| 419 | copymode(src, dst, follow_symlinks=follow_symlinks) |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 420 | return dst |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 421 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 422 | def copy2(src, dst, *, follow_symlinks=True): |
Zsolt Cserna | 4f399be | 2018-10-23 12:09:50 +0200 | [diff] [blame] | 423 | """Copy data and metadata. Return the file's destination. |
| 424 | |
| 425 | Metadata is copied with copystat(). Please see the copystat function |
| 426 | for more information. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 427 | |
| 428 | The destination may be a directory. |
| 429 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 430 | If follow_symlinks is false, symlinks won't be followed. This |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 431 | resembles GNU's "cp -P src dst". |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 432 | """ |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 433 | if os.path.isdir(dst): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 434 | dst = os.path.join(dst, os.path.basename(src)) |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 435 | copyfile(src, dst, follow_symlinks=follow_symlinks) |
| 436 | copystat(src, dst, follow_symlinks=follow_symlinks) |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 437 | return dst |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 438 | |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 439 | def ignore_patterns(*patterns): |
| 440 | """Function that can be used as copytree() ignore parameter. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 441 | |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 442 | Patterns is a sequence of glob-style patterns |
| 443 | that are used to exclude files""" |
| 444 | def _ignore_patterns(path, names): |
| 445 | ignored_names = [] |
| 446 | for pattern in patterns: |
| 447 | ignored_names.extend(fnmatch.filter(names, pattern)) |
| 448 | return set(ignored_names) |
| 449 | return _ignore_patterns |
| 450 | |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 451 | def _copytree(entries, src, dst, symlinks, ignore, copy_function, |
jab | 9e00d9e | 2018-12-28 13:03:40 -0500 | [diff] [blame] | 452 | ignore_dangling_symlinks, dirs_exist_ok=False): |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 453 | if ignore is not None: |
mbarkhau | 8870433 | 2020-01-24 14:51:16 +0000 | [diff] [blame] | 454 | ignored_names = ignore(os.fspath(src), [x.name for x in entries]) |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 455 | else: |
| 456 | ignored_names = set() |
| 457 | |
jab | 9e00d9e | 2018-12-28 13:03:40 -0500 | [diff] [blame] | 458 | os.makedirs(dst, exist_ok=dirs_exist_ok) |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 459 | errors = [] |
| 460 | use_srcentry = copy_function is copy2 or copy_function is copy |
| 461 | |
| 462 | for srcentry in entries: |
| 463 | if srcentry.name in ignored_names: |
| 464 | continue |
| 465 | srcname = os.path.join(src, srcentry.name) |
| 466 | dstname = os.path.join(dst, srcentry.name) |
| 467 | srcobj = srcentry if use_srcentry else srcname |
| 468 | try: |
Steve Dower | df2d4a6 | 2019-08-21 15:27:33 -0700 | [diff] [blame] | 469 | is_symlink = srcentry.is_symlink() |
| 470 | if is_symlink and os.name == 'nt': |
| 471 | # Special check for directory junctions, which appear as |
| 472 | # symlinks but we want to recurse. |
| 473 | lstat = srcentry.stat(follow_symlinks=False) |
| 474 | if lstat.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT: |
| 475 | is_symlink = False |
| 476 | if is_symlink: |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 477 | linkto = os.readlink(srcname) |
| 478 | if symlinks: |
| 479 | # We can't just leave it to `copy_function` because legacy |
| 480 | # code with a custom `copy_function` may rely on copytree |
| 481 | # doing the right thing. |
| 482 | os.symlink(linkto, dstname) |
| 483 | copystat(srcobj, dstname, follow_symlinks=not symlinks) |
| 484 | else: |
| 485 | # ignore dangling symlink if the flag is on |
| 486 | if not os.path.exists(linkto) and ignore_dangling_symlinks: |
| 487 | continue |
jab | 9e00d9e | 2018-12-28 13:03:40 -0500 | [diff] [blame] | 488 | # otherwise let the copy occur. copy2 will raise an error |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 489 | if srcentry.is_dir(): |
| 490 | copytree(srcobj, dstname, symlinks, ignore, |
jab | 9e00d9e | 2018-12-28 13:03:40 -0500 | [diff] [blame] | 491 | copy_function, dirs_exist_ok=dirs_exist_ok) |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 492 | else: |
| 493 | copy_function(srcobj, dstname) |
| 494 | elif srcentry.is_dir(): |
jab | 9e00d9e | 2018-12-28 13:03:40 -0500 | [diff] [blame] | 495 | copytree(srcobj, dstname, symlinks, ignore, copy_function, |
| 496 | dirs_exist_ok=dirs_exist_ok) |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 497 | else: |
| 498 | # Will raise a SpecialFileError for unsupported file types |
Giampaolo Rodola | c606a9c | 2019-02-26 12:04:41 +0100 | [diff] [blame] | 499 | copy_function(srcobj, dstname) |
Giampaolo Rodola | 19c46a4 | 2018-11-12 06:18:15 -0800 | [diff] [blame] | 500 | # catch the Error from the recursive copytree so that we can |
| 501 | # continue with other files |
| 502 | except Error as err: |
| 503 | errors.extend(err.args[0]) |
| 504 | except OSError as why: |
| 505 | errors.append((srcname, dstname, str(why))) |
| 506 | try: |
| 507 | copystat(src, dst) |
| 508 | except OSError as why: |
| 509 | # Copying file access times may fail on Windows |
| 510 | if getattr(why, 'winerror', None) is None: |
| 511 | errors.append((src, dst, str(why))) |
| 512 | if errors: |
| 513 | raise Error(errors) |
| 514 | return dst |
| 515 | |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 516 | def copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, |
jab | 9e00d9e | 2018-12-28 13:03:40 -0500 | [diff] [blame] | 517 | ignore_dangling_symlinks=False, dirs_exist_ok=False): |
| 518 | """Recursively copy a directory tree and return the destination directory. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 519 | |
jab | 9e00d9e | 2018-12-28 13:03:40 -0500 | [diff] [blame] | 520 | dirs_exist_ok dictates whether to raise an exception in case dst or any |
| 521 | missing parent directory already exists. |
| 522 | |
Neal Norwitz | a4c93b6 | 2003-02-23 21:36:32 +0000 | [diff] [blame] | 523 | If exception(s) occur, an Error is raised with a list of reasons. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 524 | |
| 525 | If the optional symlinks flag is true, symbolic links in the |
| 526 | source tree result in symbolic links in the destination tree; if |
| 527 | it is false, the contents of the files pointed to by symbolic |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 528 | links are copied. If the file pointed by the symlink doesn't |
| 529 | exist, an exception will be added in the list of errors raised in |
| 530 | an Error exception at the end of the copy process. |
| 531 | |
| 532 | You can set the optional ignore_dangling_symlinks flag to true if you |
Tarek Ziadé | 8c26c7d | 2010-04-23 13:03:50 +0000 | [diff] [blame] | 533 | want to silence this exception. Notice that this has no effect on |
| 534 | platforms that don't support os.symlink. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 535 | |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 536 | The optional ignore argument is a callable. If given, it |
| 537 | is called with the `src` parameter, which is the directory |
| 538 | being visited by copytree(), and `names` which is the list of |
| 539 | `src` contents, as returned by os.listdir(): |
| 540 | |
| 541 | callable(src, names) -> ignored_names |
| 542 | |
| 543 | Since copytree() is called recursively, the callable will be |
| 544 | called once for each directory that is copied. It returns a |
| 545 | list of names relative to the `src` directory that should |
| 546 | not be copied. |
| 547 | |
Tarek Ziadé | 5340db3 | 2010-04-19 22:30:51 +0000 | [diff] [blame] | 548 | The optional copy_function argument is a callable that will be used |
| 549 | to copy each file. It will be called with the source path and the |
| 550 | destination path as arguments. By default, copy2() is used, but any |
| 551 | function that supports the same signature (like copy()) can be used. |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 552 | |
| 553 | """ |
Steve Dower | 60419a7 | 2019-06-24 08:42:54 -0700 | [diff] [blame] | 554 | sys.audit("shutil.copytree", src, dst) |
Bruno P. Kinoshita | 9bbcbc9 | 2019-11-27 14:10:37 +1300 | [diff] [blame] | 555 | with os.scandir(src) as itr: |
| 556 | entries = list(itr) |
| 557 | return _copytree(entries=entries, src=src, dst=dst, symlinks=symlinks, |
| 558 | ignore=ignore, copy_function=copy_function, |
| 559 | ignore_dangling_symlinks=ignore_dangling_symlinks, |
| 560 | dirs_exist_ok=dirs_exist_ok) |
Guido van Rossum | d767329 | 1998-02-06 21:38:09 +0000 | [diff] [blame] | 561 | |
Ned Deily | 7fcc208 | 2019-08-29 17:20:03 -0400 | [diff] [blame] | 562 | if hasattr(os.stat_result, 'st_file_attributes'): |
Steve Dower | df2d4a6 | 2019-08-21 15:27:33 -0700 | [diff] [blame] | 563 | # Special handling for directory junctions to make them behave like |
| 564 | # symlinks for shutil.rmtree, since in general they do not appear as |
| 565 | # regular links. |
| 566 | def _rmtree_isdir(entry): |
| 567 | try: |
| 568 | st = entry.stat(follow_symlinks=False) |
| 569 | return (stat.S_ISDIR(st.st_mode) and not |
| 570 | (st.st_file_attributes & stat.FILE_ATTRIBUTE_REPARSE_POINT |
| 571 | and st.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT)) |
| 572 | except OSError: |
| 573 | return False |
| 574 | |
| 575 | def _rmtree_islink(path): |
| 576 | try: |
| 577 | st = os.lstat(path) |
| 578 | return (stat.S_ISLNK(st.st_mode) or |
| 579 | (st.st_file_attributes & stat.FILE_ATTRIBUTE_REPARSE_POINT |
| 580 | and st.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT)) |
| 581 | except OSError: |
| 582 | return False |
| 583 | else: |
| 584 | def _rmtree_isdir(entry): |
| 585 | try: |
| 586 | return entry.is_dir(follow_symlinks=False) |
| 587 | except OSError: |
| 588 | return False |
| 589 | |
| 590 | def _rmtree_islink(path): |
| 591 | return os.path.islink(path) |
| 592 | |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 593 | # version vulnerable to race conditions |
| 594 | def _rmtree_unsafe(path, onerror): |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 595 | try: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 596 | with os.scandir(path) as scandir_it: |
| 597 | entries = list(scandir_it) |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 598 | except OSError: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 599 | onerror(os.scandir, path, sys.exc_info()) |
| 600 | entries = [] |
| 601 | for entry in entries: |
| 602 | fullname = entry.path |
Steve Dower | df2d4a6 | 2019-08-21 15:27:33 -0700 | [diff] [blame] | 603 | if _rmtree_isdir(entry): |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 604 | try: |
| 605 | if entry.is_symlink(): |
| 606 | # This can only happen if someone replaces |
| 607 | # a directory with a symlink after the call to |
| 608 | # os.scandir or entry.is_dir above. |
| 609 | raise OSError("Cannot call rmtree on a symbolic link") |
| 610 | except OSError: |
| 611 | onerror(os.path.islink, fullname, sys.exc_info()) |
| 612 | continue |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 613 | _rmtree_unsafe(fullname, onerror) |
Barry Warsaw | 234d9a9 | 2003-01-24 17:36:15 +0000 | [diff] [blame] | 614 | else: |
Johannes Gijsbers | ef5ffc4 | 2004-10-31 12:05:31 +0000 | [diff] [blame] | 615 | try: |
Hynek Schlawack | 2100b42 | 2012-06-23 20:28:32 +0200 | [diff] [blame] | 616 | os.unlink(fullname) |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 617 | except OSError: |
Hynek Schlawack | 2100b42 | 2012-06-23 20:28:32 +0200 | [diff] [blame] | 618 | onerror(os.unlink, fullname, sys.exc_info()) |
Johannes Gijsbers | ef5ffc4 | 2004-10-31 12:05:31 +0000 | [diff] [blame] | 619 | try: |
| 620 | os.rmdir(path) |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 621 | except OSError: |
Johannes Gijsbers | ef5ffc4 | 2004-10-31 12:05:31 +0000 | [diff] [blame] | 622 | onerror(os.rmdir, path, sys.exc_info()) |
Guido van Rossum | d767329 | 1998-02-06 21:38:09 +0000 | [diff] [blame] | 623 | |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 624 | # Version using fd-based APIs to protect against races |
| 625 | def _rmtree_safe_fd(topfd, path, onerror): |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 626 | try: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 627 | with os.scandir(topfd) as scandir_it: |
| 628 | entries = list(scandir_it) |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 629 | except OSError as err: |
| 630 | err.filename = path |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 631 | onerror(os.scandir, path, sys.exc_info()) |
| 632 | return |
| 633 | for entry in entries: |
| 634 | fullname = os.path.join(path, entry.name) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 635 | try: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 636 | is_dir = entry.is_dir(follow_symlinks=False) |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 637 | except OSError: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 638 | is_dir = False |
Serhiy Storchaka | e9b51c0 | 2019-05-31 11:30:37 +0300 | [diff] [blame] | 639 | else: |
| 640 | if is_dir: |
| 641 | try: |
| 642 | orig_st = entry.stat(follow_symlinks=False) |
| 643 | is_dir = stat.S_ISDIR(orig_st.st_mode) |
| 644 | except OSError: |
| 645 | onerror(os.lstat, fullname, sys.exc_info()) |
| 646 | continue |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 647 | if is_dir: |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 648 | try: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 649 | dirfd = os.open(entry.name, os.O_RDONLY, dir_fd=topfd) |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 650 | except OSError: |
Hynek Schlawack | 2100b42 | 2012-06-23 20:28:32 +0200 | [diff] [blame] | 651 | onerror(os.open, fullname, sys.exc_info()) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 652 | else: |
| 653 | try: |
| 654 | if os.path.samestat(orig_st, os.fstat(dirfd)): |
| 655 | _rmtree_safe_fd(dirfd, fullname, onerror) |
Hynek Schlawack | 9f558cc | 2012-06-28 15:30:47 +0200 | [diff] [blame] | 656 | try: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 657 | os.rmdir(entry.name, dir_fd=topfd) |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 658 | except OSError: |
Hynek Schlawack | 9f558cc | 2012-06-28 15:30:47 +0200 | [diff] [blame] | 659 | onerror(os.rmdir, fullname, sys.exc_info()) |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 660 | else: |
| 661 | try: |
| 662 | # This can only happen if someone replaces |
| 663 | # a directory with a symlink after the call to |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 664 | # os.scandir or stat.S_ISDIR above. |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 665 | raise OSError("Cannot call rmtree on a symbolic " |
| 666 | "link") |
| 667 | except OSError: |
| 668 | onerror(os.path.islink, fullname, sys.exc_info()) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 669 | finally: |
| 670 | os.close(dirfd) |
| 671 | else: |
| 672 | try: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 673 | os.unlink(entry.name, dir_fd=topfd) |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 674 | except OSError: |
Hynek Schlawack | 2100b42 | 2012-06-23 20:28:32 +0200 | [diff] [blame] | 675 | onerror(os.unlink, fullname, sys.exc_info()) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 676 | |
Hynek Schlawack | d0f6e0a | 2012-06-29 08:28:20 +0200 | [diff] [blame] | 677 | _use_fd_functions = ({os.open, os.stat, os.unlink, os.rmdir} <= |
| 678 | os.supports_dir_fd and |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 679 | os.scandir in os.supports_fd and |
Hynek Schlawack | d0f6e0a | 2012-06-29 08:28:20 +0200 | [diff] [blame] | 680 | os.stat in os.supports_follow_symlinks) |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 681 | |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 682 | def rmtree(path, ignore_errors=False, onerror=None): |
| 683 | """Recursively delete a directory tree. |
| 684 | |
| 685 | If ignore_errors is set, errors are ignored; otherwise, if onerror |
| 686 | is set, it is called to handle the error with arguments (func, |
Hynek Schlawack | 2100b42 | 2012-06-23 20:28:32 +0200 | [diff] [blame] | 687 | path, exc_info) where func is platform and implementation dependent; |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 688 | path is the argument to that function that caused it to fail; and |
| 689 | exc_info is a tuple returned by sys.exc_info(). If ignore_errors |
| 690 | is false and onerror is None, an exception is raised. |
| 691 | |
| 692 | """ |
Steve Dower | 60419a7 | 2019-06-24 08:42:54 -0700 | [diff] [blame] | 693 | sys.audit("shutil.rmtree", path) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 694 | if ignore_errors: |
| 695 | def onerror(*args): |
| 696 | pass |
| 697 | elif onerror is None: |
| 698 | def onerror(*args): |
| 699 | raise |
| 700 | if _use_fd_functions: |
Hynek Schlawack | 3b52778 | 2012-06-25 13:27:31 +0200 | [diff] [blame] | 701 | # While the unsafe rmtree works fine on bytes, the fd based does not. |
| 702 | if isinstance(path, bytes): |
| 703 | path = os.fsdecode(path) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 704 | # Note: To guard against symlink races, we use the standard |
| 705 | # lstat()/open()/fstat() trick. |
| 706 | try: |
| 707 | orig_st = os.lstat(path) |
| 708 | except Exception: |
| 709 | onerror(os.lstat, path, sys.exc_info()) |
| 710 | return |
| 711 | try: |
| 712 | fd = os.open(path, os.O_RDONLY) |
| 713 | except Exception: |
Michal Čihař | e59b2de | 2020-11-10 17:06:02 +0100 | [diff] [blame] | 714 | onerror(os.open, path, sys.exc_info()) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 715 | return |
| 716 | try: |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 717 | if os.path.samestat(orig_st, os.fstat(fd)): |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 718 | _rmtree_safe_fd(fd, path, onerror) |
Hynek Schlawack | 9f558cc | 2012-06-28 15:30:47 +0200 | [diff] [blame] | 719 | try: |
| 720 | os.rmdir(path) |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 721 | except OSError: |
Hynek Schlawack | 9f558cc | 2012-06-28 15:30:47 +0200 | [diff] [blame] | 722 | onerror(os.rmdir, path, sys.exc_info()) |
Hynek Schlawack | a75cd1c | 2012-06-28 12:07:29 +0200 | [diff] [blame] | 723 | else: |
Hynek Schlawack | b550110 | 2012-12-10 09:11:25 +0100 | [diff] [blame] | 724 | try: |
| 725 | # symlinks to directories are forbidden, see bug #1669 |
| 726 | raise OSError("Cannot call rmtree on a symbolic link") |
| 727 | except OSError: |
| 728 | onerror(os.path.islink, path, sys.exc_info()) |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 729 | finally: |
| 730 | os.close(fd) |
| 731 | else: |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 732 | try: |
Steve Dower | df2d4a6 | 2019-08-21 15:27:33 -0700 | [diff] [blame] | 733 | if _rmtree_islink(path): |
Serhiy Storchaka | d4d79bc | 2017-11-04 14:16:35 +0200 | [diff] [blame] | 734 | # symlinks to directories are forbidden, see bug #1669 |
| 735 | raise OSError("Cannot call rmtree on a symbolic link") |
| 736 | except OSError: |
| 737 | onerror(os.path.islink, path, sys.exc_info()) |
| 738 | # can't continue even if onerror hook returns |
| 739 | return |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 740 | return _rmtree_unsafe(path, onerror) |
| 741 | |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 742 | # Allow introspection of whether or not the hardening against symlink |
| 743 | # attacks is supported on the current platform |
| 744 | rmtree.avoids_symlink_attacks = _use_fd_functions |
Martin v. Löwis | e9ce0b0 | 2002-10-07 13:23:24 +0000 | [diff] [blame] | 745 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 746 | def _basename(path): |
Maxwell A McKinnon | cf57cab | 2019-09-30 19:41:16 -0700 | [diff] [blame] | 747 | """A basename() variant which first strips the trailing slash, if present. |
| 748 | Thus we always get the last component of the path, even for directories. |
| 749 | |
| 750 | path: Union[PathLike, str] |
| 751 | |
| 752 | e.g. |
| 753 | >>> os.path.basename('/bar/foo') |
| 754 | 'foo' |
| 755 | >>> os.path.basename('/bar/foo/') |
| 756 | '' |
| 757 | >>> _basename('/bar/foo/') |
| 758 | 'foo' |
| 759 | """ |
| 760 | path = os.fspath(path) |
Serhiy Storchaka | 3a308b9 | 2014-02-11 10:30:59 +0200 | [diff] [blame] | 761 | sep = os.path.sep + (os.path.altsep or '') |
| 762 | return os.path.basename(path.rstrip(sep)) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 763 | |
R David Murray | 6ffface | 2014-06-11 14:40:13 -0400 | [diff] [blame] | 764 | def move(src, dst, copy_function=copy2): |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 765 | """Recursively move a file or directory to another location. This is |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 766 | similar to the Unix "mv" command. Return the file or directory's |
| 767 | destination. |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 768 | |
| 769 | If the destination is a directory or a symlink to a directory, the source |
| 770 | is moved inside the directory. The destination path must not already |
| 771 | exist. |
| 772 | |
| 773 | If the destination already exists but is not a directory, it may be |
| 774 | overwritten depending on os.rename() semantics. |
| 775 | |
| 776 | If the destination is on our current filesystem, then rename() is used. |
Antoine Pitrou | 0a08d7a | 2012-01-06 20:16:19 +0100 | [diff] [blame] | 777 | Otherwise, src is copied to the destination and then removed. Symlinks are |
| 778 | recreated under the new name if os.rename() fails because of cross |
| 779 | filesystem renames. |
| 780 | |
R David Murray | 6ffface | 2014-06-11 14:40:13 -0400 | [diff] [blame] | 781 | The optional `copy_function` argument is a callable that will be used |
| 782 | to copy the source or it will be delegated to `copytree`. |
| 783 | By default, copy2() is used, but any function that supports the same |
| 784 | signature (like copy()) can be used. |
| 785 | |
Martin v. Löwis | e9ce0b0 | 2002-10-07 13:23:24 +0000 | [diff] [blame] | 786 | A lot more could be done here... A look at a mv.c shows a lot of |
| 787 | the issues this implementation glosses over. |
| 788 | |
| 789 | """ |
Saiyang Gou | 7514f4f | 2020-02-12 23:47:42 -0800 | [diff] [blame] | 790 | sys.audit("shutil.move", src, dst) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 791 | real_dst = dst |
| 792 | if os.path.isdir(dst): |
Ronald Oussoren | f51738b | 2011-05-06 10:23:04 +0200 | [diff] [blame] | 793 | if _samefile(src, dst): |
| 794 | # We might be on a case insensitive filesystem, |
| 795 | # perform the rename anyway. |
| 796 | os.rename(src, dst) |
| 797 | return |
| 798 | |
Maxwell A McKinnon | cf57cab | 2019-09-30 19:41:16 -0700 | [diff] [blame] | 799 | # Using _basename instead of os.path.basename is important, as we must |
| 800 | # ignore any trailing slash to avoid the basename returning '' |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 801 | real_dst = os.path.join(dst, _basename(src)) |
Maxwell A McKinnon | cf57cab | 2019-09-30 19:41:16 -0700 | [diff] [blame] | 802 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 803 | if os.path.exists(real_dst): |
| 804 | raise Error("Destination path '%s' already exists" % real_dst) |
Martin v. Löwis | e9ce0b0 | 2002-10-07 13:23:24 +0000 | [diff] [blame] | 805 | try: |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 806 | os.rename(src, real_dst) |
Éric Araujo | cfcc977 | 2011-08-10 20:54:33 +0200 | [diff] [blame] | 807 | except OSError: |
Antoine Pitrou | 0a08d7a | 2012-01-06 20:16:19 +0100 | [diff] [blame] | 808 | if os.path.islink(src): |
| 809 | linkto = os.readlink(src) |
| 810 | os.symlink(linkto, real_dst) |
| 811 | os.unlink(src) |
| 812 | elif os.path.isdir(src): |
Benjamin Peterson | 247a9b8 | 2009-02-20 04:09:19 +0000 | [diff] [blame] | 813 | if _destinsrc(src, dst): |
R David Murray | 6ffface | 2014-06-11 14:40:13 -0400 | [diff] [blame] | 814 | raise Error("Cannot move a directory '%s' into itself" |
| 815 | " '%s'." % (src, dst)) |
| 816 | copytree(src, real_dst, copy_function=copy_function, |
| 817 | symlinks=True) |
Martin v. Löwis | e9ce0b0 | 2002-10-07 13:23:24 +0000 | [diff] [blame] | 818 | rmtree(src) |
| 819 | else: |
R David Murray | 6ffface | 2014-06-11 14:40:13 -0400 | [diff] [blame] | 820 | copy_function(src, real_dst) |
Martin v. Löwis | e9ce0b0 | 2002-10-07 13:23:24 +0000 | [diff] [blame] | 821 | os.unlink(src) |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 822 | return real_dst |
Brett Cannon | 1c3fa18 | 2004-06-19 21:11:35 +0000 | [diff] [blame] | 823 | |
Benjamin Peterson | 247a9b8 | 2009-02-20 04:09:19 +0000 | [diff] [blame] | 824 | def _destinsrc(src, dst): |
Berker Peksag | 3715da5 | 2014-09-18 05:11:15 +0300 | [diff] [blame] | 825 | src = os.path.abspath(src) |
| 826 | dst = os.path.abspath(dst) |
Antoine Pitrou | 0dcc3cd | 2009-01-29 20:26:59 +0000 | [diff] [blame] | 827 | if not src.endswith(os.path.sep): |
| 828 | src += os.path.sep |
| 829 | if not dst.endswith(os.path.sep): |
| 830 | dst += os.path.sep |
| 831 | return dst.startswith(src) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 832 | |
| 833 | def _get_gid(name): |
| 834 | """Returns a gid, given a group name.""" |
| 835 | if getgrnam is None or name is None: |
| 836 | return None |
| 837 | try: |
| 838 | result = getgrnam(name) |
| 839 | except KeyError: |
| 840 | result = None |
| 841 | if result is not None: |
| 842 | return result[2] |
| 843 | return None |
| 844 | |
| 845 | def _get_uid(name): |
| 846 | """Returns an uid, given a user name.""" |
| 847 | if getpwnam is None or name is None: |
| 848 | return None |
| 849 | try: |
| 850 | result = getpwnam(name) |
| 851 | except KeyError: |
| 852 | result = None |
| 853 | if result is not None: |
| 854 | return result[2] |
| 855 | return None |
| 856 | |
| 857 | def _make_tarball(base_name, base_dir, compress="gzip", verbose=0, dry_run=0, |
| 858 | owner=None, group=None, logger=None): |
| 859 | """Create a (possibly compressed) tar file from all the files under |
| 860 | 'base_dir'. |
| 861 | |
Serhiy Storchaka | 1121377 | 2014-08-06 18:50:19 +0300 | [diff] [blame] | 862 | 'compress' must be "gzip" (the default), "bzip2", "xz", or None. |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 863 | |
| 864 | 'owner' and 'group' can be used to define an owner and a group for the |
| 865 | archive that is being built. If not provided, the current owner and group |
| 866 | will be used. |
| 867 | |
Éric Araujo | 4433a5f | 2010-12-15 20:26:30 +0000 | [diff] [blame] | 868 | The output tar file will be named 'base_name' + ".tar", possibly plus |
Serhiy Storchaka | 1121377 | 2014-08-06 18:50:19 +0300 | [diff] [blame] | 869 | the appropriate compression extension (".gz", ".bz2", or ".xz"). |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 870 | |
| 871 | Returns the output filename. |
| 872 | """ |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 873 | if compress is None: |
| 874 | tar_compression = '' |
| 875 | elif _ZLIB_SUPPORTED and compress == 'gzip': |
| 876 | tar_compression = 'gz' |
| 877 | elif _BZ2_SUPPORTED and compress == 'bzip2': |
| 878 | tar_compression = 'bz2' |
| 879 | elif _LZMA_SUPPORTED and compress == 'xz': |
| 880 | tar_compression = 'xz' |
| 881 | else: |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 882 | raise ValueError("bad value for 'compress', or compression format not " |
| 883 | "supported : {0}".format(compress)) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 884 | |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 885 | import tarfile # late import for breaking circular dependency |
| 886 | |
| 887 | compress_ext = '.' + tar_compression if compress else '' |
| 888 | archive_name = base_name + '.tar' + compress_ext |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 889 | archive_dir = os.path.dirname(archive_name) |
Tarek Ziadé | 5e2be87 | 2010-04-20 21:40:47 +0000 | [diff] [blame] | 890 | |
Serhiy Storchaka | 9a4fc19 | 2014-11-28 00:48:46 +0200 | [diff] [blame] | 891 | if archive_dir and not os.path.exists(archive_dir): |
Éric Araujo | ac4e58e | 2011-01-29 20:32:11 +0000 | [diff] [blame] | 892 | if logger is not None: |
Éric Araujo | 43a7ee1 | 2011-08-19 02:55:11 +0200 | [diff] [blame] | 893 | logger.info("creating %s", archive_dir) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 894 | if not dry_run: |
| 895 | os.makedirs(archive_dir) |
| 896 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 897 | # creating the tarball |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 898 | if logger is not None: |
| 899 | logger.info('Creating tar archive') |
| 900 | |
| 901 | uid = _get_uid(owner) |
| 902 | gid = _get_gid(group) |
| 903 | |
| 904 | def _set_uid_gid(tarinfo): |
| 905 | if gid is not None: |
| 906 | tarinfo.gid = gid |
| 907 | tarinfo.gname = group |
| 908 | if uid is not None: |
| 909 | tarinfo.uid = uid |
| 910 | tarinfo.uname = owner |
| 911 | return tarinfo |
| 912 | |
| 913 | if not dry_run: |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 914 | tar = tarfile.open(archive_name, 'w|%s' % tar_compression) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 915 | try: |
| 916 | tar.add(base_dir, filter=_set_uid_gid) |
| 917 | finally: |
| 918 | tar.close() |
| 919 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 920 | return archive_name |
| 921 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 922 | def _make_zipfile(base_name, base_dir, verbose=0, dry_run=0, logger=None): |
| 923 | """Create a zip file from all the files under 'base_dir'. |
| 924 | |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 925 | The output zip file will be named 'base_name' + ".zip". Returns the |
| 926 | name of the output zip file. |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 927 | """ |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 928 | import zipfile # late import for breaking circular dependency |
Andrew Kuchling | a0934b2 | 2014-03-20 16:11:16 -0400 | [diff] [blame] | 929 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 930 | zip_filename = base_name + ".zip" |
| 931 | archive_dir = os.path.dirname(base_name) |
| 932 | |
Serhiy Storchaka | 9a4fc19 | 2014-11-28 00:48:46 +0200 | [diff] [blame] | 933 | if archive_dir and not os.path.exists(archive_dir): |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 934 | if logger is not None: |
| 935 | logger.info("creating %s", archive_dir) |
| 936 | if not dry_run: |
| 937 | os.makedirs(archive_dir) |
| 938 | |
Andrew Kuchling | a0934b2 | 2014-03-20 16:11:16 -0400 | [diff] [blame] | 939 | if logger is not None: |
| 940 | logger.info("creating '%s' and adding '%s' to it", |
| 941 | zip_filename, base_dir) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 942 | |
Andrew Kuchling | a0934b2 | 2014-03-20 16:11:16 -0400 | [diff] [blame] | 943 | if not dry_run: |
| 944 | with zipfile.ZipFile(zip_filename, "w", |
| 945 | compression=zipfile.ZIP_DEFLATED) as zf: |
Serhiy Storchaka | d941d7a | 2015-09-08 05:51:00 +0300 | [diff] [blame] | 946 | path = os.path.normpath(base_dir) |
Serhiy Storchaka | 666de77 | 2016-10-23 15:55:09 +0300 | [diff] [blame] | 947 | if path != os.curdir: |
| 948 | zf.write(path, path) |
| 949 | if logger is not None: |
| 950 | logger.info("adding '%s'", path) |
Andrew Kuchling | a0934b2 | 2014-03-20 16:11:16 -0400 | [diff] [blame] | 951 | for dirpath, dirnames, filenames in os.walk(base_dir): |
Serhiy Storchaka | d941d7a | 2015-09-08 05:51:00 +0300 | [diff] [blame] | 952 | for name in sorted(dirnames): |
| 953 | path = os.path.normpath(os.path.join(dirpath, name)) |
| 954 | zf.write(path, path) |
| 955 | if logger is not None: |
| 956 | logger.info("adding '%s'", path) |
Andrew Kuchling | a0934b2 | 2014-03-20 16:11:16 -0400 | [diff] [blame] | 957 | for name in filenames: |
| 958 | path = os.path.normpath(os.path.join(dirpath, name)) |
| 959 | if os.path.isfile(path): |
| 960 | zf.write(path, path) |
| 961 | if logger is not None: |
| 962 | logger.info("adding '%s'", path) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 963 | |
| 964 | return zip_filename |
| 965 | |
| 966 | _ARCHIVE_FORMATS = { |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 967 | 'tar': (_make_tarball, [('compress', None)], "uncompressed tar file"), |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 968 | } |
| 969 | |
| 970 | if _ZLIB_SUPPORTED: |
| 971 | _ARCHIVE_FORMATS['gztar'] = (_make_tarball, [('compress', 'gzip')], |
| 972 | "gzip'ed tar-file") |
| 973 | _ARCHIVE_FORMATS['zip'] = (_make_zipfile, [], "ZIP file") |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 974 | |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 975 | if _BZ2_SUPPORTED: |
| 976 | _ARCHIVE_FORMATS['bztar'] = (_make_tarball, [('compress', 'bzip2')], |
| 977 | "bzip2'ed tar-file") |
| 978 | |
Serhiy Storchaka | 1121377 | 2014-08-06 18:50:19 +0300 | [diff] [blame] | 979 | if _LZMA_SUPPORTED: |
| 980 | _ARCHIVE_FORMATS['xztar'] = (_make_tarball, [('compress', 'xz')], |
| 981 | "xz'ed tar-file") |
| 982 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 983 | def get_archive_formats(): |
| 984 | """Returns a list of supported formats for archiving and unarchiving. |
| 985 | |
| 986 | Each element of the returned sequence is a tuple (name, description) |
| 987 | """ |
| 988 | formats = [(name, registry[2]) for name, registry in |
| 989 | _ARCHIVE_FORMATS.items()] |
| 990 | formats.sort() |
| 991 | return formats |
| 992 | |
| 993 | def register_archive_format(name, function, extra_args=None, description=''): |
| 994 | """Registers an archive format. |
| 995 | |
| 996 | name is the name of the format. function is the callable that will be |
| 997 | used to create archives. If provided, extra_args is a sequence of |
| 998 | (name, value) tuples that will be passed as arguments to the callable. |
| 999 | description can be provided to describe the format, and will be returned |
| 1000 | by the get_archive_formats() function. |
| 1001 | """ |
| 1002 | if extra_args is None: |
| 1003 | extra_args = [] |
Florent Xicluna | 5d1155c | 2011-10-28 14:45:05 +0200 | [diff] [blame] | 1004 | if not callable(function): |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 1005 | raise TypeError('The %s object is not callable' % function) |
| 1006 | if not isinstance(extra_args, (tuple, list)): |
| 1007 | raise TypeError('extra_args needs to be a sequence') |
| 1008 | for element in extra_args: |
Éric Araujo | c1b7e7f | 2011-09-18 23:12:30 +0200 | [diff] [blame] | 1009 | if not isinstance(element, (tuple, list)) or len(element) !=2: |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 1010 | raise TypeError('extra_args elements are : (arg_name, value)') |
| 1011 | |
| 1012 | _ARCHIVE_FORMATS[name] = (function, extra_args, description) |
| 1013 | |
| 1014 | def unregister_archive_format(name): |
| 1015 | del _ARCHIVE_FORMATS[name] |
| 1016 | |
| 1017 | def make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0, |
| 1018 | dry_run=0, owner=None, group=None, logger=None): |
| 1019 | """Create an archive file (eg. zip or tar). |
| 1020 | |
| 1021 | 'base_name' is the name of the file to create, minus any format-specific |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 1022 | extension; 'format' is the archive format: one of "zip", "tar", "gztar", |
| 1023 | "bztar", or "xztar". Or any other registered format. |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 1024 | |
| 1025 | 'root_dir' is a directory that will be the root directory of the |
| 1026 | archive; ie. we typically chdir into 'root_dir' before creating the |
| 1027 | archive. 'base_dir' is the directory where we start archiving from; |
| 1028 | ie. 'base_dir' will be the common prefix of all files and |
| 1029 | directories in the archive. 'root_dir' and 'base_dir' both default |
| 1030 | to the current directory. Returns the name of the archive file. |
| 1031 | |
| 1032 | 'owner' and 'group' are used when creating a tar archive. By default, |
| 1033 | uses the current owner and group. |
| 1034 | """ |
Steve Dower | 60419a7 | 2019-06-24 08:42:54 -0700 | [diff] [blame] | 1035 | sys.audit("shutil.make_archive", base_name, format, root_dir, base_dir) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 1036 | save_cwd = os.getcwd() |
| 1037 | if root_dir is not None: |
| 1038 | if logger is not None: |
| 1039 | logger.debug("changing into '%s'", root_dir) |
| 1040 | base_name = os.path.abspath(base_name) |
| 1041 | if not dry_run: |
| 1042 | os.chdir(root_dir) |
| 1043 | |
| 1044 | if base_dir is None: |
| 1045 | base_dir = os.curdir |
| 1046 | |
| 1047 | kwargs = {'dry_run': dry_run, 'logger': logger} |
| 1048 | |
| 1049 | try: |
| 1050 | format_info = _ARCHIVE_FORMATS[format] |
| 1051 | except KeyError: |
Serhiy Storchaka | 5affd23 | 2017-04-05 09:37:24 +0300 | [diff] [blame] | 1052 | raise ValueError("unknown archive format '%s'" % format) from None |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 1053 | |
| 1054 | func = format_info[0] |
| 1055 | for arg, val in format_info[1]: |
| 1056 | kwargs[arg] = val |
| 1057 | |
| 1058 | if format != 'zip': |
| 1059 | kwargs['owner'] = owner |
| 1060 | kwargs['group'] = group |
| 1061 | |
| 1062 | try: |
| 1063 | filename = func(base_name, base_dir, **kwargs) |
| 1064 | finally: |
| 1065 | if root_dir is not None: |
| 1066 | if logger is not None: |
| 1067 | logger.debug("changing back to '%s'", save_cwd) |
| 1068 | os.chdir(save_cwd) |
| 1069 | |
| 1070 | return filename |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1071 | |
| 1072 | |
| 1073 | def get_unpack_formats(): |
| 1074 | """Returns a list of supported formats for unpacking. |
| 1075 | |
| 1076 | Each element of the returned sequence is a tuple |
| 1077 | (name, extensions, description) |
| 1078 | """ |
| 1079 | formats = [(name, info[0], info[3]) for name, info in |
| 1080 | _UNPACK_FORMATS.items()] |
| 1081 | formats.sort() |
| 1082 | return formats |
| 1083 | |
| 1084 | def _check_unpack_options(extensions, function, extra_args): |
| 1085 | """Checks what gets registered as an unpacker.""" |
| 1086 | # first make sure no other unpacker is registered for this extension |
| 1087 | existing_extensions = {} |
| 1088 | for name, info in _UNPACK_FORMATS.items(): |
| 1089 | for ext in info[0]: |
| 1090 | existing_extensions[ext] = name |
| 1091 | |
| 1092 | for extension in extensions: |
| 1093 | if extension in existing_extensions: |
| 1094 | msg = '%s is already registered for "%s"' |
| 1095 | raise RegistryError(msg % (extension, |
| 1096 | existing_extensions[extension])) |
| 1097 | |
Florent Xicluna | 5d1155c | 2011-10-28 14:45:05 +0200 | [diff] [blame] | 1098 | if not callable(function): |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1099 | raise TypeError('The registered function must be a callable') |
| 1100 | |
| 1101 | |
| 1102 | def register_unpack_format(name, extensions, function, extra_args=None, |
| 1103 | description=''): |
| 1104 | """Registers an unpack format. |
| 1105 | |
| 1106 | `name` is the name of the format. `extensions` is a list of extensions |
| 1107 | corresponding to the format. |
| 1108 | |
| 1109 | `function` is the callable that will be |
| 1110 | used to unpack archives. The callable will receive archives to unpack. |
| 1111 | If it's unable to handle an archive, it needs to raise a ReadError |
| 1112 | exception. |
| 1113 | |
| 1114 | If provided, `extra_args` is a sequence of |
| 1115 | (name, value) tuples that will be passed as arguments to the callable. |
| 1116 | description can be provided to describe the format, and will be returned |
| 1117 | by the get_unpack_formats() function. |
| 1118 | """ |
| 1119 | if extra_args is None: |
| 1120 | extra_args = [] |
| 1121 | _check_unpack_options(extensions, function, extra_args) |
| 1122 | _UNPACK_FORMATS[name] = extensions, function, extra_args, description |
| 1123 | |
| 1124 | def unregister_unpack_format(name): |
Martin Panter | eb99570 | 2016-07-28 01:11:04 +0000 | [diff] [blame] | 1125 | """Removes the pack format from the registry.""" |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1126 | del _UNPACK_FORMATS[name] |
| 1127 | |
| 1128 | def _ensure_directory(path): |
| 1129 | """Ensure that the parent directory of `path` exists""" |
| 1130 | dirname = os.path.dirname(path) |
| 1131 | if not os.path.isdir(dirname): |
| 1132 | os.makedirs(dirname) |
| 1133 | |
| 1134 | def _unpack_zipfile(filename, extract_dir): |
| 1135 | """Unpack zip `filename` to `extract_dir` |
| 1136 | """ |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 1137 | import zipfile # late import for breaking circular dependency |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1138 | |
| 1139 | if not zipfile.is_zipfile(filename): |
| 1140 | raise ReadError("%s is not a zip file" % filename) |
| 1141 | |
| 1142 | zip = zipfile.ZipFile(filename) |
| 1143 | try: |
| 1144 | for info in zip.infolist(): |
| 1145 | name = info.filename |
| 1146 | |
| 1147 | # don't extract absolute paths or ones with .. in them |
| 1148 | if name.startswith('/') or '..' in name: |
| 1149 | continue |
| 1150 | |
| 1151 | target = os.path.join(extract_dir, *name.split('/')) |
| 1152 | if not target: |
| 1153 | continue |
| 1154 | |
| 1155 | _ensure_directory(target) |
| 1156 | if not name.endswith('/'): |
| 1157 | # file |
| 1158 | data = zip.read(info.filename) |
Éric Araujo | c1b7e7f | 2011-09-18 23:12:30 +0200 | [diff] [blame] | 1159 | f = open(target, 'wb') |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1160 | try: |
| 1161 | f.write(data) |
| 1162 | finally: |
| 1163 | f.close() |
| 1164 | del data |
| 1165 | finally: |
| 1166 | zip.close() |
| 1167 | |
| 1168 | def _unpack_tarfile(filename, extract_dir): |
Serhiy Storchaka | 1121377 | 2014-08-06 18:50:19 +0300 | [diff] [blame] | 1169 | """Unpack tar/tar.gz/tar.bz2/tar.xz `filename` to `extract_dir` |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1170 | """ |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 1171 | import tarfile # late import for breaking circular dependency |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1172 | try: |
| 1173 | tarobj = tarfile.open(filename) |
| 1174 | except tarfile.TarError: |
| 1175 | raise ReadError( |
| 1176 | "%s is not a compressed or uncompressed tar file" % filename) |
| 1177 | try: |
| 1178 | tarobj.extractall(extract_dir) |
| 1179 | finally: |
| 1180 | tarobj.close() |
| 1181 | |
| 1182 | _UNPACK_FORMATS = { |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1183 | 'tar': (['.tar'], _unpack_tarfile, [], "uncompressed tar file"), |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 1184 | 'zip': (['.zip'], _unpack_zipfile, [], "ZIP file"), |
| 1185 | } |
| 1186 | |
| 1187 | if _ZLIB_SUPPORTED: |
| 1188 | _UNPACK_FORMATS['gztar'] = (['.tar.gz', '.tgz'], _unpack_tarfile, [], |
| 1189 | "gzip'ed tar-file") |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1190 | |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 1191 | if _BZ2_SUPPORTED: |
Serhiy Storchaka | 1121377 | 2014-08-06 18:50:19 +0300 | [diff] [blame] | 1192 | _UNPACK_FORMATS['bztar'] = (['.tar.bz2', '.tbz2'], _unpack_tarfile, [], |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 1193 | "bzip2'ed tar-file") |
| 1194 | |
Serhiy Storchaka | 1121377 | 2014-08-06 18:50:19 +0300 | [diff] [blame] | 1195 | if _LZMA_SUPPORTED: |
| 1196 | _UNPACK_FORMATS['xztar'] = (['.tar.xz', '.txz'], _unpack_tarfile, [], |
| 1197 | "xz'ed tar-file") |
| 1198 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1199 | def _find_unpack_format(filename): |
| 1200 | for name, info in _UNPACK_FORMATS.items(): |
| 1201 | for extension in info[0]: |
| 1202 | if filename.endswith(extension): |
| 1203 | return name |
| 1204 | return None |
| 1205 | |
| 1206 | def unpack_archive(filename, extract_dir=None, format=None): |
| 1207 | """Unpack an archive. |
| 1208 | |
| 1209 | `filename` is the name of the archive. |
| 1210 | |
| 1211 | `extract_dir` is the name of the target directory, where the archive |
| 1212 | is unpacked. If not provided, the current working directory is used. |
| 1213 | |
Serhiy Storchaka | 20cdffd | 2016-12-16 18:58:33 +0200 | [diff] [blame] | 1214 | `format` is the archive format: one of "zip", "tar", "gztar", "bztar", |
| 1215 | or "xztar". Or any other registered format. If not provided, |
| 1216 | unpack_archive will use the filename extension and see if an unpacker |
| 1217 | was registered for that extension. |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1218 | |
| 1219 | In case none is found, a ValueError is raised. |
| 1220 | """ |
Saiyang Gou | 7514f4f | 2020-02-12 23:47:42 -0800 | [diff] [blame] | 1221 | sys.audit("shutil.unpack_archive", filename, extract_dir, format) |
| 1222 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1223 | if extract_dir is None: |
| 1224 | extract_dir = os.getcwd() |
| 1225 | |
Jelle Zijlstra | a12df7b | 2017-05-05 14:27:12 -0700 | [diff] [blame] | 1226 | extract_dir = os.fspath(extract_dir) |
| 1227 | filename = os.fspath(filename) |
| 1228 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1229 | if format is not None: |
| 1230 | try: |
| 1231 | format_info = _UNPACK_FORMATS[format] |
| 1232 | except KeyError: |
Serhiy Storchaka | 5affd23 | 2017-04-05 09:37:24 +0300 | [diff] [blame] | 1233 | raise ValueError("Unknown unpack format '{0}'".format(format)) from None |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1234 | |
Nick Coghlan | abf202d | 2011-03-16 13:52:20 -0400 | [diff] [blame] | 1235 | func = format_info[1] |
| 1236 | func(filename, extract_dir, **dict(format_info[2])) |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 1237 | else: |
| 1238 | # we need to look at the registered unpackers supported extensions |
| 1239 | format = _find_unpack_format(filename) |
| 1240 | if format is None: |
| 1241 | raise ReadError("Unknown archive format '{0}'".format(filename)) |
| 1242 | |
| 1243 | func = _UNPACK_FORMATS[format][1] |
| 1244 | kwargs = dict(_UNPACK_FORMATS[format][2]) |
| 1245 | func(filename, extract_dir, **kwargs) |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 1246 | |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 1247 | |
| 1248 | if hasattr(os, 'statvfs'): |
| 1249 | |
| 1250 | __all__.append('disk_usage') |
| 1251 | _ntuple_diskusage = collections.namedtuple('usage', 'total used free') |
Raymond Hettinger | 5b798ab | 2015-08-17 22:04:45 -0700 | [diff] [blame] | 1252 | _ntuple_diskusage.total.__doc__ = 'Total space in bytes' |
| 1253 | _ntuple_diskusage.used.__doc__ = 'Used space in bytes' |
| 1254 | _ntuple_diskusage.free.__doc__ = 'Free space in bytes' |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 1255 | |
| 1256 | def disk_usage(path): |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 1257 | """Return disk usage statistics about the given path. |
| 1258 | |
Sandro Tosi | f8ae4fa | 2012-04-23 20:07:15 +0200 | [diff] [blame] | 1259 | Returned value is a named tuple with attributes 'total', 'used' and |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 1260 | 'free', which are the amount of total, used and free space, in bytes. |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 1261 | """ |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 1262 | st = os.statvfs(path) |
| 1263 | free = st.f_bavail * st.f_frsize |
| 1264 | total = st.f_blocks * st.f_frsize |
| 1265 | used = (st.f_blocks - st.f_bfree) * st.f_frsize |
| 1266 | return _ntuple_diskusage(total, used, free) |
| 1267 | |
Giampaolo Rodola | c7f02a9 | 2018-06-19 08:27:29 -0700 | [diff] [blame] | 1268 | elif _WINDOWS: |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 1269 | |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 1270 | __all__.append('disk_usage') |
| 1271 | _ntuple_diskusage = collections.namedtuple('usage', 'total used free') |
| 1272 | |
| 1273 | def disk_usage(path): |
| 1274 | """Return disk usage statistics about the given path. |
| 1275 | |
Ezio Melotti | 30b9d5d | 2013-08-17 15:50:46 +0300 | [diff] [blame] | 1276 | Returned values is a named tuple with attributes 'total', 'used' and |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 1277 | 'free', which are the amount of total, used and free space, in bytes. |
| 1278 | """ |
| 1279 | total, free = nt._getdiskusage(path) |
| 1280 | used = total - free |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 1281 | return _ntuple_diskusage(total, used, free) |
Sandro Tosi | d902a14 | 2011-08-22 23:28:27 +0200 | [diff] [blame] | 1282 | |
Éric Araujo | 0ac4a5d | 2011-09-01 08:31:51 +0200 | [diff] [blame] | 1283 | |
Sandro Tosi | d902a14 | 2011-08-22 23:28:27 +0200 | [diff] [blame] | 1284 | def chown(path, user=None, group=None): |
| 1285 | """Change owner user and group of the given path. |
| 1286 | |
| 1287 | user and group can be the uid/gid or the user/group names, and in that case, |
| 1288 | they are converted to their respective uid/gid. |
| 1289 | """ |
Saiyang Gou | 7514f4f | 2020-02-12 23:47:42 -0800 | [diff] [blame] | 1290 | sys.audit('shutil.chown', path, user, group) |
Sandro Tosi | d902a14 | 2011-08-22 23:28:27 +0200 | [diff] [blame] | 1291 | |
| 1292 | if user is None and group is None: |
| 1293 | raise ValueError("user and/or group must be set") |
| 1294 | |
| 1295 | _user = user |
| 1296 | _group = group |
| 1297 | |
| 1298 | # -1 means don't change it |
| 1299 | if user is None: |
| 1300 | _user = -1 |
| 1301 | # user can either be an int (the uid) or a string (the system username) |
| 1302 | elif isinstance(user, str): |
| 1303 | _user = _get_uid(user) |
| 1304 | if _user is None: |
| 1305 | raise LookupError("no such user: {!r}".format(user)) |
| 1306 | |
| 1307 | if group is None: |
| 1308 | _group = -1 |
| 1309 | elif not isinstance(group, int): |
| 1310 | _group = _get_gid(group) |
| 1311 | if _group is None: |
| 1312 | raise LookupError("no such group: {!r}".format(group)) |
| 1313 | |
| 1314 | os.chown(path, _user, _group) |
Antoine Pitrou | bcf2b59 | 2012-02-08 23:28:36 +0100 | [diff] [blame] | 1315 | |
| 1316 | def get_terminal_size(fallback=(80, 24)): |
| 1317 | """Get the size of the terminal window. |
| 1318 | |
| 1319 | For each of the two dimensions, the environment variable, COLUMNS |
| 1320 | and LINES respectively, is checked. If the variable is defined and |
| 1321 | the value is a positive integer, it is used. |
| 1322 | |
| 1323 | When COLUMNS or LINES is not defined, which is the common case, |
| 1324 | the terminal connected to sys.__stdout__ is queried |
| 1325 | by invoking os.get_terminal_size. |
| 1326 | |
| 1327 | If the terminal size cannot be successfully queried, either because |
| 1328 | the system doesn't support querying, or because we are not |
| 1329 | connected to a terminal, the value given in fallback parameter |
| 1330 | is used. Fallback defaults to (80, 24) which is the default |
| 1331 | size used by many terminal emulators. |
| 1332 | |
| 1333 | The value returned is a named tuple of type os.terminal_size. |
| 1334 | """ |
| 1335 | # columns, lines are the working values |
| 1336 | try: |
| 1337 | columns = int(os.environ['COLUMNS']) |
| 1338 | except (KeyError, ValueError): |
| 1339 | columns = 0 |
| 1340 | |
| 1341 | try: |
| 1342 | lines = int(os.environ['LINES']) |
| 1343 | except (KeyError, ValueError): |
| 1344 | lines = 0 |
| 1345 | |
| 1346 | # only query if necessary |
| 1347 | if columns <= 0 or lines <= 0: |
| 1348 | try: |
| 1349 | size = os.get_terminal_size(sys.__stdout__.fileno()) |
Serhiy Storchaka | d30829d | 2016-04-24 09:58:43 +0300 | [diff] [blame] | 1350 | except (AttributeError, ValueError, OSError): |
| 1351 | # stdout is None, closed, detached, or not a terminal, or |
| 1352 | # os.get_terminal_size() is unsupported |
Antoine Pitrou | bcf2b59 | 2012-02-08 23:28:36 +0100 | [diff] [blame] | 1353 | size = os.terminal_size(fallback) |
| 1354 | if columns <= 0: |
| 1355 | columns = size.columns |
| 1356 | if lines <= 0: |
| 1357 | lines = size.lines |
| 1358 | |
| 1359 | return os.terminal_size((columns, lines)) |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1360 | |
Cheryl Sabella | 5680f65 | 2019-02-13 06:25:10 -0500 | [diff] [blame] | 1361 | |
| 1362 | # Check that a given file can be accessed with the correct mode. |
| 1363 | # Additionally check that `file` is not a directory, as on Windows |
| 1364 | # directories pass the os.access check. |
| 1365 | def _access_check(fn, mode): |
| 1366 | return (os.path.exists(fn) and os.access(fn, mode) |
| 1367 | and not os.path.isdir(fn)) |
| 1368 | |
| 1369 | |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1370 | def which(cmd, mode=os.F_OK | os.X_OK, path=None): |
Brian Curtin | dc00f1e | 2012-06-22 22:49:12 -0500 | [diff] [blame] | 1371 | """Given a command, mode, and a PATH string, return the path which |
Philip Jenvey | 88bc0d2 | 2012-06-23 15:54:38 -0700 | [diff] [blame] | 1372 | conforms to the given mode on the PATH, or None if there is no such |
| 1373 | file. |
| 1374 | |
| 1375 | `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result |
| 1376 | of os.environ.get("PATH"), or can be overridden with a custom search |
| 1377 | path. |
| 1378 | |
| 1379 | """ |
Serhiy Storchaka | 8bea200 | 2013-01-23 10:44:21 +0200 | [diff] [blame] | 1380 | # If we're given a path with a directory part, look it up directly rather |
| 1381 | # than referring to PATH directories. This includes checking relative to the |
| 1382 | # current directory, e.g. ./script |
| 1383 | if os.path.dirname(cmd): |
| 1384 | if _access_check(cmd, mode): |
| 1385 | return cmd |
| 1386 | return None |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1387 | |
Cheryl Sabella | 5680f65 | 2019-02-13 06:25:10 -0500 | [diff] [blame] | 1388 | use_bytes = isinstance(cmd, bytes) |
| 1389 | |
Barry Warsaw | 618738b | 2013-04-16 11:05:03 -0400 | [diff] [blame] | 1390 | if path is None: |
Victor Stinner | 228a3c9 | 2019-04-17 16:26:36 +0200 | [diff] [blame] | 1391 | path = os.environ.get("PATH", None) |
| 1392 | if path is None: |
| 1393 | try: |
| 1394 | path = os.confstr("CS_PATH") |
| 1395 | except (AttributeError, ValueError): |
| 1396 | # os.confstr() or CS_PATH is not available |
| 1397 | path = os.defpath |
| 1398 | # bpo-35755: Don't use os.defpath if the PATH environment variable is |
Victor Stinner | 197f044 | 2019-04-17 17:44:06 +0200 | [diff] [blame] | 1399 | # set to an empty string |
Victor Stinner | 228a3c9 | 2019-04-17 16:26:36 +0200 | [diff] [blame] | 1400 | |
| 1401 | # PATH='' doesn't match, whereas PATH=':' looks in the current directory |
Barry Warsaw | 618738b | 2013-04-16 11:05:03 -0400 | [diff] [blame] | 1402 | if not path: |
| 1403 | return None |
Victor Stinner | 228a3c9 | 2019-04-17 16:26:36 +0200 | [diff] [blame] | 1404 | |
Cheryl Sabella | 5680f65 | 2019-02-13 06:25:10 -0500 | [diff] [blame] | 1405 | if use_bytes: |
| 1406 | path = os.fsencode(path) |
| 1407 | path = path.split(os.fsencode(os.pathsep)) |
| 1408 | else: |
| 1409 | path = os.fsdecode(path) |
| 1410 | path = path.split(os.pathsep) |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1411 | |
| 1412 | if sys.platform == "win32": |
| 1413 | # The current directory takes precedence on Windows. |
Cheryl Sabella | 5680f65 | 2019-02-13 06:25:10 -0500 | [diff] [blame] | 1414 | curdir = os.curdir |
| 1415 | if use_bytes: |
| 1416 | curdir = os.fsencode(curdir) |
| 1417 | if curdir not in path: |
| 1418 | path.insert(0, curdir) |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1419 | |
| 1420 | # PATHEXT is necessary to check on Windows. |
Christopher Marchfelder | da6f098 | 2020-10-23 12:08:24 +0200 | [diff] [blame] | 1421 | pathext_source = os.getenv("PATHEXT") or _WIN_DEFAULT_PATHEXT |
| 1422 | pathext = [ext for ext in pathext_source.split(os.pathsep) if ext] |
| 1423 | |
Cheryl Sabella | 5680f65 | 2019-02-13 06:25:10 -0500 | [diff] [blame] | 1424 | if use_bytes: |
| 1425 | pathext = [os.fsencode(ext) for ext in pathext] |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1426 | # See if the given file matches any of the expected path extensions. |
| 1427 | # This will allow us to short circuit when given "python.exe". |
Philip Jenvey | 88bc0d2 | 2012-06-23 15:54:38 -0700 | [diff] [blame] | 1428 | # If it does match, only test that one, otherwise we have to try |
| 1429 | # others. |
Serhiy Storchaka | 014791f | 2013-01-21 15:00:27 +0200 | [diff] [blame] | 1430 | if any(cmd.lower().endswith(ext.lower()) for ext in pathext): |
| 1431 | files = [cmd] |
| 1432 | else: |
| 1433 | files = [cmd + ext for ext in pathext] |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1434 | else: |
| 1435 | # On other platforms you don't have things like PATHEXT to tell you |
| 1436 | # what file suffixes are executable, so just pass on cmd as-is. |
| 1437 | files = [cmd] |
| 1438 | |
| 1439 | seen = set() |
| 1440 | for dir in path: |
Serhiy Storchaka | 014791f | 2013-01-21 15:00:27 +0200 | [diff] [blame] | 1441 | normdir = os.path.normcase(dir) |
| 1442 | if not normdir in seen: |
| 1443 | seen.add(normdir) |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 1444 | for thefile in files: |
| 1445 | name = os.path.join(dir, thefile) |
| 1446 | if _access_check(name, mode): |
| 1447 | return name |
| 1448 | return None |