Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1 | """Utility functions for copying 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 |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 10 | |
Skip Montanaro | 0de6580 | 2001-02-15 22:15:14 +0000 | [diff] [blame] | 11 | __all__ = ["copyfileobj","copyfile","copymode","copystat","copy","copy2", |
| 12 | "copytree","rmtree"] |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 13 | |
Greg Stein | 42bb8b3 | 2000-07-12 09:55:30 +0000 | [diff] [blame] | 14 | def copyfileobj(fsrc, fdst, length=16*1024): |
| 15 | """copy data from file-like object fsrc to file-like object fdst""" |
| 16 | while 1: |
| 17 | buf = fsrc.read(length) |
| 18 | if not buf: |
| 19 | break |
| 20 | fdst.write(buf) |
| 21 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 22 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 23 | def copyfile(src, dst): |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 24 | """Copy data from src to dst""" |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 25 | fsrc = None |
| 26 | fdst = None |
Raymond Hettinger | 57e7945 | 2002-09-08 20:43:59 +0000 | [diff] [blame] | 27 | # check for same pathname; all platforms |
| 28 | _src = os.path.normcase(os.path.abspath(src)) |
| 29 | _dst = os.path.normcase(os.path.abspath(dst)) |
| 30 | if _src == _dst: |
| 31 | return |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 32 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 33 | fsrc = open(src, 'rb') |
| 34 | fdst = open(dst, 'wb') |
Greg Stein | 42bb8b3 | 2000-07-12 09:55:30 +0000 | [diff] [blame] | 35 | copyfileobj(fsrc, fdst) |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 36 | finally: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 37 | if fdst: |
| 38 | fdst.close() |
| 39 | if fsrc: |
| 40 | fsrc.close() |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 41 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 42 | def copymode(src, dst): |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 43 | """Copy mode bits from src to dst""" |
Tim Peters | 0c94724 | 2001-01-21 20:00:00 +0000 | [diff] [blame] | 44 | if hasattr(os, 'chmod'): |
| 45 | st = os.stat(src) |
Walter Dörwald | 294bbf3 | 2002-06-06 09:48:13 +0000 | [diff] [blame] | 46 | mode = stat.S_IMODE(st.st_mode) |
Tim Peters | 0c94724 | 2001-01-21 20:00:00 +0000 | [diff] [blame] | 47 | os.chmod(dst, mode) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 48 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 49 | def copystat(src, dst): |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 50 | """Copy all stat info (mode bits, atime and mtime) from src to dst""" |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 51 | st = os.stat(src) |
Walter Dörwald | 294bbf3 | 2002-06-06 09:48:13 +0000 | [diff] [blame] | 52 | mode = stat.S_IMODE(st.st_mode) |
Tim Peters | 0c94724 | 2001-01-21 20:00:00 +0000 | [diff] [blame] | 53 | if hasattr(os, 'utime'): |
Walter Dörwald | 294bbf3 | 2002-06-06 09:48:13 +0000 | [diff] [blame] | 54 | os.utime(dst, (st.st_atime, st.st_mtime)) |
Tim Peters | 0c94724 | 2001-01-21 20:00:00 +0000 | [diff] [blame] | 55 | if hasattr(os, 'chmod'): |
| 56 | os.chmod(dst, mode) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 57 | |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 58 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 59 | def copy(src, dst): |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 60 | """Copy data and mode bits ("cp src dst"). |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 61 | |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 62 | The destination may be a directory. |
| 63 | |
| 64 | """ |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 65 | if os.path.isdir(dst): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 66 | dst = os.path.join(dst, os.path.basename(src)) |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 67 | copyfile(src, dst) |
| 68 | copymode(src, dst) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 69 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 70 | def copy2(src, dst): |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 71 | """Copy data and all stat info ("cp -p src dst"). |
| 72 | |
| 73 | The destination may be a directory. |
| 74 | |
| 75 | """ |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 76 | if os.path.isdir(dst): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 77 | dst = os.path.join(dst, os.path.basename(src)) |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 78 | copyfile(src, dst) |
| 79 | copystat(src, dst) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 80 | |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 81 | |
| 82 | def copytree(src, dst, symlinks=0): |
| 83 | """Recursively copy a directory tree using copy2(). |
| 84 | |
| 85 | The destination directory must not already exist. |
| 86 | Error are reported to standard output. |
| 87 | |
| 88 | If the optional symlinks flag is true, symbolic links in the |
| 89 | source tree result in symbolic links in the destination tree; if |
| 90 | it is false, the contents of the files pointed to by symbolic |
| 91 | links are copied. |
| 92 | |
| 93 | XXX Consider this example code rather than the ultimate tool. |
| 94 | |
| 95 | """ |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 96 | names = os.listdir(src) |
Guido van Rossum | 9d0a3df | 1997-04-29 14:45:19 +0000 | [diff] [blame] | 97 | os.mkdir(dst) |
Guido van Rossum | a2baf46 | 1997-04-29 14:06:46 +0000 | [diff] [blame] | 98 | for name in names: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 99 | srcname = os.path.join(src, name) |
| 100 | dstname = os.path.join(dst, name) |
| 101 | try: |
| 102 | if symlinks and os.path.islink(srcname): |
| 103 | linkto = os.readlink(srcname) |
| 104 | os.symlink(linkto, dstname) |
| 105 | elif os.path.isdir(srcname): |
Fred Drake | 5fa3886 | 2000-04-07 14:34:50 +0000 | [diff] [blame] | 106 | copytree(srcname, dstname, symlinks) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 107 | else: |
| 108 | copy2(srcname, dstname) |
| 109 | # XXX What about devices, sockets etc.? |
| 110 | except (IOError, os.error), why: |
| 111 | print "Can't copy %s to %s: %s" % (`srcname`, `dstname`, str(why)) |
Guido van Rossum | d767329 | 1998-02-06 21:38:09 +0000 | [diff] [blame] | 112 | |
| 113 | def rmtree(path, ignore_errors=0, onerror=None): |
| 114 | """Recursively delete a directory tree. |
| 115 | |
| 116 | If ignore_errors is set, errors are ignored; otherwise, if |
| 117 | onerror is set, it is called to handle the error; otherwise, an |
| 118 | exception is raised. |
| 119 | |
| 120 | """ |
| 121 | cmdtuples = [] |
| 122 | _build_cmdtuple(path, cmdtuples) |
| 123 | for cmd in cmdtuples: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 124 | try: |
| 125 | apply(cmd[0], (cmd[1],)) |
| 126 | except: |
| 127 | exc = sys.exc_info() |
| 128 | if ignore_errors: |
| 129 | pass |
Raymond Hettinger | f13eb55 | 2002-06-02 00:40:05 +0000 | [diff] [blame] | 130 | elif onerror is not None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 131 | onerror(cmd[0], cmd[1], exc) |
| 132 | else: |
| 133 | raise exc[0], (exc[1][0], exc[1][1] + ' removing '+cmd[1]) |
Guido van Rossum | d767329 | 1998-02-06 21:38:09 +0000 | [diff] [blame] | 134 | |
| 135 | # Helper for rmtree() |
| 136 | def _build_cmdtuple(path, cmdtuples): |
| 137 | for f in os.listdir(path): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 138 | real_f = os.path.join(path,f) |
| 139 | if os.path.isdir(real_f) and not os.path.islink(real_f): |
| 140 | _build_cmdtuple(real_f, cmdtuples) |
| 141 | else: |
Guido van Rossum | d832f9e | 1998-10-07 13:18:17 +0000 | [diff] [blame] | 142 | cmdtuples.append((os.remove, real_f)) |
| 143 | cmdtuples.append((os.rmdir, path)) |