annotate Lib/distutils/dir_util.py @ 78069:a8aa77458e12 3.2

Add c_size_t and c_ssize_t to the ctypes summary table.
author Antoine Pitrou <solipsis@pitrou.net>
date Thu, 12 Jul 2012 20:31:50 +0200
parents 3e26c9033306
children d978828bfd0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
1 """distutils.dir_util
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
2
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
3 Utility functions for manipulating directories and directory trees."""
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
4
26423
3d2869de2336 Part of the fix for bug #410541: add ensure_relative() function
Andrew M. Kuchling <amk@amk.ca>
parents: 26285
diff changeset
5 import os, sys
66317
eed42d283562 Merged revisions 86601,86605 via svnmerge from
Éric Araujo <merwok@netwok.org>
parents: 66015
diff changeset
6 import errno
12779
0570de9c8202 'mkpath()' now detects non-string 'name' arguments -- this is a fairly common
Greg Ward <gward@python.net>
parents: 12226
diff changeset
7 from distutils.errors import DistutilsFileError, DistutilsInternalError
23668
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 21267
diff changeset
8 from distutils import log
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
9
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
10 # cache for by mkpath() -- in addition to cheapening redundant calls,
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
11 # eliminates redundant "creating /foo/bar/baz" messages in dry-run mode
12938
7ab5b1eeebde Renamed PATH_CREATED to _path_created, on the grounds that it's private and
Greg Ward <gward@python.net>
parents: 12937
diff changeset
12 _path_created = {}
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
13
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
14 # I don't use os.makedirs because a) it's new to Python 1.5.2, and
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
15 # b) it blows up if the directory already exists (I want to silently
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
16 # succeed in that case).
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
17 def mkpath(name, mode=0o777, verbose=1, dry_run=0):
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
18 """Create a directory and any missing ancestor directories.
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
19
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
20 If the directory already exists (or if 'name' is the empty string, which
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
21 means the current directory, which of course exists), then do nothing.
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
22 Raise DistutilsFileError if unable to create some directory along the way
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
23 (eg. some sub-path exists, but is a file rather than a directory).
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
24 If 'verbose' is true, print a one-line summary of each mkdir to stdout.
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
25 Return the list of directories actually created.
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
26 """
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
27
12938
7ab5b1eeebde Renamed PATH_CREATED to _path_created, on the grounds that it's private and
Greg Ward <gward@python.net>
parents: 12937
diff changeset
28 global _path_created
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
29
12779
0570de9c8202 'mkpath()' now detects non-string 'name' arguments -- this is a fairly common
Greg Ward <gward@python.net>
parents: 12226
diff changeset
30 # Detect a common bug -- name is None
43577
ace45b361e87 Patch# 1258 by Christian Heimes: kill basestring.
Guido van Rossum <guido@python.org>
parents: 43026
diff changeset
31 if not isinstance(name, str):
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42982
diff changeset
32 raise DistutilsInternalError(
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42982
diff changeset
33 "mkpath: 'name' must be a string (got %r)" % (name,))
12779
0570de9c8202 'mkpath()' now detects non-string 'name' arguments -- this is a fairly common
Greg Ward <gward@python.net>
parents: 12226
diff changeset
34
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
35 # XXX what's the better way to handle verbosity? print as we create
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
36 # each directory in the path (the current behaviour), or only announce
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
37 # the creation of the whole path? (quite easy to do the latter since
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
38 # we're not using a recursive algorithm)
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
39
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
40 name = os.path.normpath(name)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
41 created_dirs = []
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
42 if os.path.isdir(name) or name == '':
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
43 return created_dirs
14947
73cea59657ba Andrew Kuchling: changed so the '_path_created' dictionary is keyed on
Greg Ward <gward@python.net>
parents: 14863
diff changeset
44 if _path_created.get(os.path.abspath(name)):
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
45 return created_dirs
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
46
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
47 (head, tail) = os.path.split(name)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
48 tails = [tail] # stack of lone dirs to create
21267
7a7f557b4d54 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14947
diff changeset
49
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
50 while head and tail and not os.path.isdir(head):
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
51 (head, tail) = os.path.split(head)
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
52 tails.insert(0, tail) # push next higher dir onto stack
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
53
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
54 # now 'head' contains the deepest directory that already exists
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
55 # (that is, the child of 'head' in 'name' is the highest directory
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
56 # that does *not* exist)
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
57 for d in tails:
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
58 #print "head = %s, d = %s: " % (head, d),
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
59 head = os.path.join(head, d)
14947
73cea59657ba Andrew Kuchling: changed so the '_path_created' dictionary is keyed on
Greg Ward <gward@python.net>
parents: 14863
diff changeset
60 abs_head = os.path.abspath(head)
73cea59657ba Andrew Kuchling: changed so the '_path_created' dictionary is keyed on
Greg Ward <gward@python.net>
parents: 14863
diff changeset
61
73cea59657ba Andrew Kuchling: changed so the '_path_created' dictionary is keyed on
Greg Ward <gward@python.net>
parents: 14863
diff changeset
62 if _path_created.get(abs_head):
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
63 continue
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
64
51370
540fbe5c8163 Merged revisions 69332 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 51362
diff changeset
65 if verbose >= 1:
51362
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
66 log.info("creating %s", head)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
67
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
68 if not dry_run:
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
69 try:
64793
e39ad5dc11cf Merged revisions 84861 via svnmerge from
Senthil Kumaran <orsenthil@gmail.com>
parents: 54160
diff changeset
70 os.mkdir(head, mode)
40587
6b18a095c2e7 SF patch 1631942 by Collin Winter:
Guido van Rossum <guido@python.org>
parents: 39597
diff changeset
71 except OSError as exc:
66015
2b7eb0e86d07 Merged revisions 86244 via svnmerge from
Éric Araujo <merwok@netwok.org>
parents: 64793
diff changeset
72 if not (exc.errno == errno.EEXIST and os.path.isdir(head)):
2b7eb0e86d07 Merged revisions 86244 via svnmerge from
Éric Araujo <merwok@netwok.org>
parents: 64793
diff changeset
73 raise DistutilsFileError(
2b7eb0e86d07 Merged revisions 86244 via svnmerge from
Éric Araujo <merwok@netwok.org>
parents: 64793
diff changeset
74 "could not create '%s': %s" % (head, exc.args[-1]))
2b7eb0e86d07 Merged revisions 86244 via svnmerge from
Éric Araujo <merwok@netwok.org>
parents: 64793
diff changeset
75 created_dirs.append(head)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
76
14947
73cea59657ba Andrew Kuchling: changed so the '_path_created' dictionary is keyed on
Greg Ward <gward@python.net>
parents: 14863
diff changeset
77 _path_created[abs_head] = 1
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
78 return created_dirs
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
79
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
80 def create_tree(base_dir, files, mode=0o777, verbose=1, dry_run=0):
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
81 """Create all the empty directories under 'base_dir' needed to put 'files'
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
82 there.
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
83
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
84 'base_dir' is just the a name of a directory which doesn't necessarily
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
85 exist yet; 'files' is a list of filenames to be interpreted relative to
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
86 'base_dir'. 'base_dir' + the directory portion of every file in 'files'
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
87 will be created if it doesn't already exist. 'mode', 'verbose' and
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
88 'dry_run' flags are as for 'mkpath()'.
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
89 """
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
90 # First get the list of directories to create
42132
863ed7cd45dc Merged revisions 56020-56124 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 42084
diff changeset
91 need_dir = set()
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
92 for file in files:
42132
863ed7cd45dc Merged revisions 56020-56124 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 42084
diff changeset
93 need_dir.add(os.path.join(base_dir, os.path.dirname(file)))
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
94
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
95 # Now create them
42132
863ed7cd45dc Merged revisions 56020-56124 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 42084
diff changeset
96 for dir in sorted(need_dir):
51362
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
97 mkpath(dir, mode, verbose=verbose, dry_run=dry_run)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
98
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
99 def copy_tree(src, dst, preserve_mode=1, preserve_times=1,
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
100 preserve_symlinks=0, update=0, verbose=1, dry_run=0):
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
101 """Copy an entire directory tree 'src' to a new location 'dst'.
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
102
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
103 Both 'src' and 'dst' must be directory names. If 'src' is not a
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
104 directory, raise DistutilsFileError. If 'dst' does not exist, it is
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
105 created with 'mkpath()'. The end result of the copy is that every
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
106 file in 'src' is copied to 'dst', and directories under 'src' are
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
107 recursively copied to 'dst'. Return the list of files that were
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
108 copied or might have been copied, using their output name. The
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
109 return value is unaffected by 'update' or 'dry_run': it is simply
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
110 the list of all files under 'src', with the names changed to be
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
111 under 'dst'.
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
112
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
113 'preserve_mode' and 'preserve_times' are the same as for
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
114 'copy_file'; note that they only apply to regular files, not to
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
115 directories. If 'preserve_symlinks' is true, symlinks will be
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
116 copied as symlinks (on platforms that support them!); otherwise
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
117 (the default), the destination of the symlink will be copied.
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
118 'update' and 'verbose' are the same as for 'copy_file'.
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
119 """
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
120 from distutils.file_util import copy_file
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
121
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
122 if not dry_run and not os.path.isdir(src):
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42982
diff changeset
123 raise DistutilsFileError(
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42982
diff changeset
124 "cannot copy tree '%s': not a directory" % src)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
125 try:
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
126 names = os.listdir(src)
40587
6b18a095c2e7 SF patch 1631942 by Collin Winter:
Guido van Rossum <guido@python.org>
parents: 39597
diff changeset
127 except os.error as e:
6b18a095c2e7 SF patch 1631942 by Collin Winter:
Guido van Rossum <guido@python.org>
parents: 39597
diff changeset
128 (errno, errstr) = e
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
129 if dry_run:
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
130 names = []
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
131 else:
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42982
diff changeset
132 raise DistutilsFileError(
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42982
diff changeset
133 "error listing files in '%s': %s" % (src, errstr))
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
134
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
135 if not dry_run:
51362
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
136 mkpath(dst, verbose=verbose)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
137
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
138 outputs = []
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
139
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
140 for n in names:
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
141 src_name = os.path.join(src, n)
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
142 dst_name = os.path.join(dst, n)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
143
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
144 if preserve_symlinks and os.path.islink(src_name):
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
145 link_dest = os.readlink(src_name)
51370
540fbe5c8163 Merged revisions 69332 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 51362
diff changeset
146 if verbose >= 1:
51362
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
147 log.info("linking %s -> %s", dst_name, link_dest)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
148 if not dry_run:
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
149 os.symlink(link_dest, dst_name)
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
150 outputs.append(dst_name)
21267
7a7f557b4d54 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14947
diff changeset
151
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
152 elif os.path.isdir(src_name):
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
153 outputs.extend(
23668
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 21267
diff changeset
154 copy_tree(src_name, dst_name, preserve_mode,
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 21267
diff changeset
155 preserve_times, preserve_symlinks, update,
51362
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
156 verbose=verbose, dry_run=dry_run))
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
157 else:
23668
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 21267
diff changeset
158 copy_file(src_name, dst_name, preserve_mode,
51362
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
159 preserve_times, update, verbose=verbose,
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
160 dry_run=dry_run)
14863
c3f0d6f19f7b Standardize whitespace in function calls.
Greg Ward <gward@python.net>
parents: 12938
diff changeset
161 outputs.append(dst_name)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
162
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
163 return outputs
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
164
12934
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
165 def _build_cmdtuple(path, cmdtuples):
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
166 """Helper for remove_tree()."""
12934
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
167 for f in os.listdir(path):
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
168 real_f = os.path.join(path,f)
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
169 if os.path.isdir(real_f) and not os.path.islink(real_f):
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
170 _build_cmdtuple(real_f, cmdtuples)
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
171 else:
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
172 cmdtuples.append((os.remove, real_f))
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
173 cmdtuples.append((os.rmdir, path))
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
174
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
175 def remove_tree(directory, verbose=1, dry_run=0):
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
176 """Recursively remove an entire directory tree.
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
177
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
178 Any errors are ignored (apart from being reported to stdout if 'verbose'
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
179 is true).
12937
abbceb6a2532 Changed 'remove_tree()' to use the new 'grok_environment_error()' function
Greg Ward <gward@python.net>
parents: 12934
diff changeset
180 """
abbceb6a2532 Changed 'remove_tree()' to use the new 'grok_environment_error()' function
Greg Ward <gward@python.net>
parents: 12934
diff changeset
181 from distutils.util import grok_environment_error
12938
7ab5b1eeebde Renamed PATH_CREATED to _path_created, on the grounds that it's private and
Greg Ward <gward@python.net>
parents: 12937
diff changeset
182 global _path_created
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
183
51370
540fbe5c8163 Merged revisions 69332 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 51362
diff changeset
184 if verbose >= 1:
51362
7e1a385847a9 Merged revisions 69324 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 43577
diff changeset
185 log.info("removing '%s' (and everything under it)", directory)
12226
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
186 if dry_run:
ffd242fed0e2 Reorganization: ripped util.py to shreds, creating in the process:
Greg Ward <gward@python.net>
parents:
diff changeset
187 return
12934
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
188 cmdtuples = []
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
189 _build_cmdtuple(directory, cmdtuples)
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
190 for cmd in cmdtuples:
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
191 try:
37048
c048a09d06ff Remove apply()
Neal Norwitz <nnorwitz@gmail.com>
parents: 35465
diff changeset
192 cmd[0](cmd[1])
12934
753f9163df0b Bastian Kleineidam: added 'remove_tree()' function. Needed so that
Greg Ward <gward@python.net>
parents: 12779
diff changeset
193 # remove dir from cache if it's already there
14947
73cea59657ba Andrew Kuchling: changed so the '_path_created' dictionary is keyed on
Greg Ward <gward@python.net>
parents: 14863
diff changeset
194 abspath = os.path.abspath(cmd[1])
39597
c33192e2c25b Get rid of a bunch more has_key() uses. We *really* need a tool for this.
Neal Norwitz <nnorwitz@gmail.com>
parents: 37048
diff changeset
195 if abspath in _path_created:
14947
73cea59657ba Andrew Kuchling: changed so the '_path_created' dictionary is keyed on
Greg Ward <gward@python.net>
parents: 14863
diff changeset
196 del _path_created[abspath]
40587
6b18a095c2e7 SF patch 1631942 by Collin Winter:
Guido van Rossum <guido@python.org>
parents: 39597
diff changeset
197 except (IOError, OSError) as exc:
23668
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 21267
diff changeset
198 log.warn(grok_environment_error(
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 21267
diff changeset
199 exc, "error removing %s: " % directory))
26423
3d2869de2336 Part of the fix for bug #410541: add ensure_relative() function
Andrew M. Kuchling <amk@amk.ca>
parents: 26285
diff changeset
200
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
201 def ensure_relative(path):
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
202 """Take the full path 'path', and make it a relative path.
26423
3d2869de2336 Part of the fix for bug #410541: add ensure_relative() function
Andrew M. Kuchling <amk@amk.ca>
parents: 26285
diff changeset
203
54160
87830461ab42 Merged revisions 72730 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54157
diff changeset
204 This is useful to make 'path' the second argument to os.path.join().
26423
3d2869de2336 Part of the fix for bug #410541: add ensure_relative() function
Andrew M. Kuchling <amk@amk.ca>
parents: 26285
diff changeset
205 """
3d2869de2336 Part of the fix for bug #410541: add ensure_relative() function
Andrew M. Kuchling <amk@amk.ca>
parents: 26285
diff changeset
206 drive, path = os.path.splitdrive(path)
54157
56adf864f380 Merged revisions 72727 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 51370
diff changeset
207 if path[0:1] == os.sep:
56adf864f380 Merged revisions 72727 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 51370
diff changeset
208 path = drive + path[1:]
56adf864f380 Merged revisions 72727 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 51370
diff changeset
209 return path