Greg Ward | 2689e3d | 1999-03-22 14:52:19 +0000 | [diff] [blame] | 1 | """distutils.util |
| 2 | |
Greg Ward | aebf706 | 2000-04-04 02:05:59 +0000 | [diff] [blame] | 3 | Miscellaneous utility functions -- anything that doesn't fit into |
Greg Ward | 4752769 | 2000-09-30 18:49:14 +0000 | [diff] [blame] | 4 | one of the other *util.py modules. |
| 5 | """ |
Greg Ward | 2689e3d | 1999-03-22 14:52:19 +0000 | [diff] [blame] | 6 | |
| 7 | # created 1999/03/08, Greg Ward |
| 8 | |
Greg Ward | 3ce77fd | 2000-03-02 01:49:45 +0000 | [diff] [blame] | 9 | __revision__ = "$Id$" |
Greg Ward | 2689e3d | 1999-03-22 14:52:19 +0000 | [diff] [blame] | 10 | |
Greg Ward | 1297b5c | 2000-09-30 20:37:56 +0000 | [diff] [blame] | 11 | import sys, os, string, re |
| 12 | from distutils.errors import DistutilsPlatformError |
| 13 | from distutils.dep_util import newer |
Greg Ward | 7c1a6d4 | 2000-03-29 02:48:40 +0000 | [diff] [blame] | 14 | from distutils.spawn import spawn |
Greg Ward | 2689e3d | 1999-03-22 14:52:19 +0000 | [diff] [blame] | 15 | |
Greg Ward | aa458bc | 2000-04-22 15:14:58 +0000 | [diff] [blame] | 16 | |
Greg Ward | 585df89 | 2000-03-01 14:40:15 +0000 | [diff] [blame] | 17 | def get_platform (): |
Greg Ward | 59399bb | 2000-09-15 01:16:14 +0000 | [diff] [blame] | 18 | """Return a string that identifies the current platform. This is used |
| 19 | mainly to distinguish platform-specific build directories and |
| 20 | platform-specific built distributions. Typically includes the OS name |
| 21 | and version and the architecture (as supplied by 'os.uname()'), |
| 22 | although the exact information included depends on the OS; eg. for IRIX |
| 23 | the architecture isn't particularly important (IRIX only runs on SGI |
| 24 | hardware), but for Linux the kernel version isn't particularly |
| 25 | important. |
| 26 | |
| 27 | Examples of returned values: |
| 28 | linux-i586 |
| 29 | linux-alpha (?) |
| 30 | solaris-2.6-sun4u |
| 31 | irix-5.3 |
| 32 | irix64-6.2 |
| 33 | |
| 34 | For non-POSIX platforms, currently just returns 'sys.platform'. |
Greg Ward | b75c485 | 2000-06-18 15:45:55 +0000 | [diff] [blame] | 35 | """ |
Greg Ward | ec84c21 | 2000-09-30 17:09:39 +0000 | [diff] [blame] | 36 | if os.name != "posix" or not hasattr(os, 'uname'): |
Greg Ward | 59399bb | 2000-09-15 01:16:14 +0000 | [diff] [blame] | 37 | # XXX what about the architecture? NT is Intel or Alpha, |
| 38 | # Mac OS is M68k or PPC, etc. |
| 39 | return sys.platform |
| 40 | |
| 41 | # Try to distinguish various flavours of Unix |
| 42 | |
| 43 | (osname, host, release, version, machine) = os.uname() |
| 44 | osname = string.lower(osname) |
| 45 | if osname[:5] == "linux": |
| 46 | # At least on Linux/Intel, 'machine' is the processor -- |
| 47 | # i386, etc. |
| 48 | # XXX what about Alpha, SPARC, etc? |
| 49 | return "%s-%s" % (osname, machine) |
| 50 | elif osname[:5] == "sunos": |
| 51 | if release[0] >= "5": # SunOS 5 == Solaris 2 |
| 52 | osname = "solaris" |
| 53 | release = "%d.%s" % (int(release[0]) - 3, release[2:]) |
| 54 | # fall through to standard osname-release-machine representation |
| 55 | elif osname[:4] == "irix": # could be "irix64"! |
| 56 | return "%s-%s" % (osname, release) |
Andrew M. Kuchling | 989835c | 2001-01-19 16:26:12 +0000 | [diff] [blame] | 57 | elif osname[:6] == "cygwin": |
| 58 | rel_re = re.compile (r'[\d.]+') |
| 59 | m = rel_re.match(release) |
| 60 | if m: |
| 61 | release = m.group() |
Greg Ward | 59399bb | 2000-09-15 01:16:14 +0000 | [diff] [blame] | 62 | |
| 63 | return "%s-%s-%s" % (osname, release, machine) |
| 64 | |
| 65 | # get_platform () |
Greg Ward | 5091929 | 2000-03-07 03:27:08 +0000 | [diff] [blame] | 66 | |
| 67 | |
Greg Ward | d8dfb4c | 2000-05-31 02:32:10 +0000 | [diff] [blame] | 68 | def convert_path (pathname): |
Greg Ward | b8b263b | 2000-09-30 18:40:42 +0000 | [diff] [blame] | 69 | """Return 'pathname' as a name that will work on the native filesystem, |
| 70 | i.e. split it on '/' and put it back together again using the current |
| 71 | directory separator. Needed because filenames in the setup script are |
| 72 | always supplied in Unix style, and have to be converted to the local |
| 73 | convention before we can actually use them in the filesystem. Raises |
Greg Ward | 4752769 | 2000-09-30 18:49:14 +0000 | [diff] [blame] | 74 | ValueError on non-Unix-ish systems if 'pathname' either starts or |
| 75 | ends with a slash. |
Greg Ward | b8b263b | 2000-09-30 18:40:42 +0000 | [diff] [blame] | 76 | """ |
Greg Ward | 7ec0535 | 2000-09-22 01:05:43 +0000 | [diff] [blame] | 77 | if os.sep == '/': |
| 78 | return pathname |
Greg Ward | 5091929 | 2000-03-07 03:27:08 +0000 | [diff] [blame] | 79 | if pathname[0] == '/': |
Greg Ward | 02a1a2b | 2000-04-15 22:15:07 +0000 | [diff] [blame] | 80 | raise ValueError, "path '%s' cannot be absolute" % pathname |
Greg Ward | 5091929 | 2000-03-07 03:27:08 +0000 | [diff] [blame] | 81 | if pathname[-1] == '/': |
Greg Ward | 02a1a2b | 2000-04-15 22:15:07 +0000 | [diff] [blame] | 82 | raise ValueError, "path '%s' cannot end with '/'" % pathname |
Greg Ward | 7ec0535 | 2000-09-22 01:05:43 +0000 | [diff] [blame] | 83 | |
| 84 | paths = string.split(pathname, '/') |
Jack Jansen | b4cd5c1 | 2001-01-28 12:23:32 +0000 | [diff] [blame] | 85 | while '.' in paths: |
| 86 | paths.remove('.') |
| 87 | if not paths: |
| 88 | return os.curdir |
Greg Ward | 7ec0535 | 2000-09-22 01:05:43 +0000 | [diff] [blame] | 89 | return apply(os.path.join, paths) |
Greg Ward | 5091929 | 2000-03-07 03:27:08 +0000 | [diff] [blame] | 90 | |
Greg Ward | d8dfb4c | 2000-05-31 02:32:10 +0000 | [diff] [blame] | 91 | # convert_path () |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 92 | |
| 93 | |
Greg Ward | 67f75d4 | 2000-04-27 01:53:46 +0000 | [diff] [blame] | 94 | def change_root (new_root, pathname): |
Greg Ward | 67f75d4 | 2000-04-27 01:53:46 +0000 | [diff] [blame] | 95 | """Return 'pathname' with 'new_root' prepended. If 'pathname' is |
| 96 | relative, this is equivalent to "os.path.join(new_root,pathname)". |
| 97 | Otherwise, it requires making 'pathname' relative and then joining the |
Greg Ward | 4b46ef9 | 2000-05-31 02:14:32 +0000 | [diff] [blame] | 98 | two, which is tricky on DOS/Windows and Mac OS. |
| 99 | """ |
| 100 | if os.name == 'posix': |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 101 | if not os.path.isabs(pathname): |
| 102 | return os.path.join(new_root, pathname) |
Greg Ward | 4b46ef9 | 2000-05-31 02:14:32 +0000 | [diff] [blame] | 103 | else: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 104 | return os.path.join(new_root, pathname[1:]) |
Greg Ward | 67f75d4 | 2000-04-27 01:53:46 +0000 | [diff] [blame] | 105 | |
| 106 | elif os.name == 'nt': |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 107 | (drive, path) = os.path.splitdrive(pathname) |
Greg Ward | 4b46ef9 | 2000-05-31 02:14:32 +0000 | [diff] [blame] | 108 | if path[0] == '\\': |
| 109 | path = path[1:] |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 110 | return os.path.join(new_root, path) |
Greg Ward | 67f75d4 | 2000-04-27 01:53:46 +0000 | [diff] [blame] | 111 | |
| 112 | elif os.name == 'mac': |
Greg Ward | f585574 | 2000-09-21 01:23:35 +0000 | [diff] [blame] | 113 | if not os.path.isabs(pathname): |
| 114 | return os.path.join(new_root, pathname) |
| 115 | else: |
| 116 | # Chop off volume name from start of path |
| 117 | elements = string.split(pathname, ":", 1) |
| 118 | pathname = ":" + elements[1] |
| 119 | return os.path.join(new_root, pathname) |
Greg Ward | 67f75d4 | 2000-04-27 01:53:46 +0000 | [diff] [blame] | 120 | |
| 121 | else: |
| 122 | raise DistutilsPlatformError, \ |
| 123 | "nothing known about platform '%s'" % os.name |
| 124 | |
| 125 | |
Gregory P. Smith | e7e35ac | 2000-05-12 00:40:00 +0000 | [diff] [blame] | 126 | _environ_checked = 0 |
| 127 | def check_environ (): |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 128 | """Ensure that 'os.environ' has all the environment variables we |
Greg Ward | b8b263b | 2000-09-30 18:40:42 +0000 | [diff] [blame] | 129 | guarantee that users can use in config files, command-line options, |
| 130 | etc. Currently this includes: |
| 131 | HOME - user's home directory (Unix only) |
| 132 | PLAT - description of the current platform, including hardware |
| 133 | and OS (see 'get_platform()') |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 134 | """ |
Gregory P. Smith | e7e35ac | 2000-05-12 00:40:00 +0000 | [diff] [blame] | 135 | global _environ_checked |
| 136 | if _environ_checked: |
| 137 | return |
| 138 | |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 139 | if os.name == 'posix' and not os.environ.has_key('HOME'): |
| 140 | import pwd |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 141 | os.environ['HOME'] = pwd.getpwuid(os.getuid())[5] |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 142 | |
| 143 | if not os.environ.has_key('PLAT'): |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 144 | os.environ['PLAT'] = get_platform() |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 145 | |
Gregory P. Smith | e7e35ac | 2000-05-12 00:40:00 +0000 | [diff] [blame] | 146 | _environ_checked = 1 |
| 147 | |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 148 | |
Jeremy Hylton | 5e2d076 | 2001-01-25 20:10:32 +0000 | [diff] [blame] | 149 | def subst_vars (s, local_vars): |
Greg Ward | b8b263b | 2000-09-30 18:40:42 +0000 | [diff] [blame] | 150 | """Perform shell/Perl-style variable substitution on 'string'. Every |
Greg Ward | 4752769 | 2000-09-30 18:49:14 +0000 | [diff] [blame] | 151 | occurrence of '$' followed by a name is considered a variable, and |
| 152 | variable is substituted by the value found in the 'local_vars' |
| 153 | dictionary, or in 'os.environ' if it's not in 'local_vars'. |
| 154 | 'os.environ' is first checked/augmented to guarantee that it contains |
| 155 | certain values: see 'check_environ()'. Raise ValueError for any |
| 156 | variables not found in either 'local_vars' or 'os.environ'. |
Greg Ward | b8b263b | 2000-09-30 18:40:42 +0000 | [diff] [blame] | 157 | """ |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 158 | check_environ() |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 159 | def _subst (match, local_vars=local_vars): |
| 160 | var_name = match.group(1) |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 161 | if local_vars.has_key(var_name): |
| 162 | return str(local_vars[var_name]) |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 163 | else: |
| 164 | return os.environ[var_name] |
| 165 | |
Greg Ward | 4752769 | 2000-09-30 18:49:14 +0000 | [diff] [blame] | 166 | try: |
Jeremy Hylton | 5e2d076 | 2001-01-25 20:10:32 +0000 | [diff] [blame] | 167 | return re.sub(r'\$([a-zA-Z_][a-zA-Z_0-9]*)', _subst, s) |
Greg Ward | 4752769 | 2000-09-30 18:49:14 +0000 | [diff] [blame] | 168 | except KeyError, var: |
| 169 | raise ValueError, "invalid variable '$%s'" % var |
Greg Ward | 1b4ede5 | 2000-03-22 00:22:44 +0000 | [diff] [blame] | 170 | |
| 171 | # subst_vars () |
Greg Ward | 7c1a6d4 | 2000-03-29 02:48:40 +0000 | [diff] [blame] | 172 | |
| 173 | |
Greg Ward | e905513 | 2000-06-17 02:16:46 +0000 | [diff] [blame] | 174 | def grok_environment_error (exc, prefix="error: "): |
| 175 | """Generate a useful error message from an EnvironmentError (IOError or |
| 176 | OSError) exception object. Handles Python 1.5.1 and 1.5.2 styles, and |
| 177 | does what it can to deal with exception objects that don't have a |
| 178 | filename (which happens when the error is due to a two-file operation, |
| 179 | such as 'rename()' or 'link()'. Returns the error message as a string |
| 180 | prefixed with 'prefix'. |
| 181 | """ |
| 182 | # check for Python 1.5.2-style {IO,OS}Error exception objects |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 183 | if hasattr(exc, 'filename') and hasattr(exc, 'strerror'): |
Greg Ward | e905513 | 2000-06-17 02:16:46 +0000 | [diff] [blame] | 184 | if exc.filename: |
| 185 | error = prefix + "%s: %s" % (exc.filename, exc.strerror) |
| 186 | else: |
| 187 | # two-argument functions in posix module don't |
| 188 | # include the filename in the exception object! |
| 189 | error = prefix + "%s" % exc.strerror |
| 190 | else: |
| 191 | error = prefix + str(exc[-1]) |
| 192 | |
| 193 | return error |
Greg Ward | 6a2a3db | 2000-06-24 20:40:02 +0000 | [diff] [blame] | 194 | |
| 195 | |
| 196 | # Needed by 'split_quoted()' |
Greg Ward | 2b042de | 2000-08-08 14:38:13 +0000 | [diff] [blame] | 197 | _wordchars_re = re.compile(r'[^\\\'\"%s ]*' % string.whitespace) |
Greg Ward | 6a2a3db | 2000-06-24 20:40:02 +0000 | [diff] [blame] | 198 | _squote_re = re.compile(r"'(?:[^'\\]|\\.)*'") |
| 199 | _dquote_re = re.compile(r'"(?:[^"\\]|\\.)*"') |
| 200 | |
| 201 | def split_quoted (s): |
| 202 | """Split a string up according to Unix shell-like rules for quotes and |
| 203 | backslashes. In short: words are delimited by spaces, as long as those |
| 204 | spaces are not escaped by a backslash, or inside a quoted string. |
| 205 | Single and double quotes are equivalent, and the quote characters can |
| 206 | be backslash-escaped. The backslash is stripped from any two-character |
| 207 | escape sequence, leaving only the escaped character. The quote |
| 208 | characters are stripped from any quoted string. Returns a list of |
| 209 | words. |
| 210 | """ |
| 211 | |
| 212 | # This is a nice algorithm for splitting up a single string, since it |
| 213 | # doesn't require character-by-character examination. It was a little |
| 214 | # bit of a brain-bender to get it working right, though... |
| 215 | |
| 216 | s = string.strip(s) |
| 217 | words = [] |
| 218 | pos = 0 |
| 219 | |
| 220 | while s: |
| 221 | m = _wordchars_re.match(s, pos) |
| 222 | end = m.end() |
| 223 | if end == len(s): |
| 224 | words.append(s[:end]) |
| 225 | break |
| 226 | |
Greg Ward | 2b042de | 2000-08-08 14:38:13 +0000 | [diff] [blame] | 227 | if s[end] in string.whitespace: # unescaped, unquoted whitespace: now |
Greg Ward | 6a2a3db | 2000-06-24 20:40:02 +0000 | [diff] [blame] | 228 | words.append(s[:end]) # we definitely have a word delimiter |
| 229 | s = string.lstrip(s[end:]) |
| 230 | pos = 0 |
| 231 | |
| 232 | elif s[end] == '\\': # preserve whatever is being escaped; |
| 233 | # will become part of the current word |
| 234 | s = s[:end] + s[end+1:] |
| 235 | pos = end+1 |
| 236 | |
| 237 | else: |
| 238 | if s[end] == "'": # slurp singly-quoted string |
| 239 | m = _squote_re.match(s, end) |
| 240 | elif s[end] == '"': # slurp doubly-quoted string |
| 241 | m = _dquote_re.match(s, end) |
| 242 | else: |
| 243 | raise RuntimeError, \ |
| 244 | "this can't happen (bad char '%c')" % s[end] |
| 245 | |
| 246 | if m is None: |
| 247 | raise ValueError, \ |
| 248 | "bad string (mismatched %s quotes?)" % s[end] |
| 249 | |
| 250 | (beg, end) = m.span() |
| 251 | s = s[:beg] + s[beg+1:end-1] + s[end:] |
| 252 | pos = m.end() - 2 |
| 253 | |
| 254 | if pos >= len(s): |
| 255 | words.append(s) |
| 256 | break |
| 257 | |
| 258 | return words |
| 259 | |
| 260 | # split_quoted () |
Greg Ward | 1c16ac3 | 2000-08-02 01:37:30 +0000 | [diff] [blame] | 261 | |
| 262 | |
| 263 | def execute (func, args, msg=None, verbose=0, dry_run=0): |
| 264 | """Perform some action that affects the outside world (eg. by writing |
| 265 | to the filesystem). Such actions are special because they are disabled |
| 266 | by the 'dry_run' flag, and announce themselves if 'verbose' is true. |
| 267 | This method takes care of all that bureaucracy for you; all you have to |
| 268 | do is supply the function to call and an argument tuple for it (to |
| 269 | embody the "external action" being performed), and an optional message |
| 270 | to print. |
| 271 | """ |
| 272 | # Generate a message if we weren't passed one |
| 273 | if msg is None: |
| 274 | msg = "%s%s" % (func.__name__, `args`) |
| 275 | if msg[-2:] == ',)': # correct for singleton tuple |
| 276 | msg = msg[0:-2] + ')' |
| 277 | |
| 278 | # Print it if verbosity level is high enough |
| 279 | if verbose: |
| 280 | print msg |
| 281 | |
| 282 | # And do it, as long as we're not in dry-run mode |
| 283 | if not dry_run: |
| 284 | apply(func, args) |
| 285 | |
| 286 | # execute() |
Greg Ward | 817dc09 | 2000-09-25 01:25:06 +0000 | [diff] [blame] | 287 | |
| 288 | |
| 289 | def strtobool (val): |
| 290 | """Convert a string representation of truth to true (1) or false (0). |
| 291 | True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values |
| 292 | are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if |
| 293 | 'val' is anything else. |
| 294 | """ |
| 295 | val = string.lower(val) |
| 296 | if val in ('y', 'yes', 't', 'true', 'on', '1'): |
| 297 | return 1 |
| 298 | elif val in ('n', 'no', 'f', 'false', 'off', '0'): |
| 299 | return 0 |
| 300 | else: |
| 301 | raise ValueError, "invalid truth value %s" % `val` |
Greg Ward | 1297b5c | 2000-09-30 20:37:56 +0000 | [diff] [blame] | 302 | |
| 303 | |
| 304 | def byte_compile (py_files, |
| 305 | optimize=0, force=0, |
| 306 | prefix=None, base_dir=None, |
| 307 | verbose=1, dry_run=0, |
| 308 | direct=None): |
Greg Ward | f217e21 | 2000-10-01 23:49:30 +0000 | [diff] [blame] | 309 | """Byte-compile a collection of Python source files to either .pyc |
| 310 | or .pyo files in the same directory. 'py_files' is a list of files |
| 311 | to compile; any files that don't end in ".py" are silently skipped. |
| 312 | 'optimize' must be one of the following: |
Greg Ward | 1297b5c | 2000-09-30 20:37:56 +0000 | [diff] [blame] | 313 | 0 - don't optimize (generate .pyc) |
| 314 | 1 - normal optimization (like "python -O") |
| 315 | 2 - extra optimization (like "python -OO") |
| 316 | If 'force' is true, all files are recompiled regardless of |
| 317 | timestamps. |
| 318 | |
| 319 | The source filename encoded in each bytecode file defaults to the |
| 320 | filenames listed in 'py_files'; you can modify these with 'prefix' and |
| 321 | 'basedir'. 'prefix' is a string that will be stripped off of each |
| 322 | source filename, and 'base_dir' is a directory name that will be |
| 323 | prepended (after 'prefix' is stripped). You can supply either or both |
| 324 | (or neither) of 'prefix' and 'base_dir', as you wish. |
| 325 | |
| 326 | If 'verbose' is true, prints out a report of each file. If 'dry_run' |
| 327 | is true, doesn't actually do anything that would affect the filesystem. |
| 328 | |
| 329 | Byte-compilation is either done directly in this interpreter process |
| 330 | with the standard py_compile module, or indirectly by writing a |
| 331 | temporary script and executing it. Normally, you should let |
| 332 | 'byte_compile()' figure out to use direct compilation or not (see |
| 333 | the source for details). The 'direct' flag is used by the script |
| 334 | generated in indirect mode; unless you know what you're doing, leave |
| 335 | it set to None. |
| 336 | """ |
| 337 | |
| 338 | # First, if the caller didn't force us into direct or indirect mode, |
| 339 | # figure out which mode we should be in. We take a conservative |
| 340 | # approach: choose direct mode *only* if the current interpreter is |
| 341 | # in debug mode and optimize is 0. If we're not in debug mode (-O |
| 342 | # or -OO), we don't know which level of optimization this |
| 343 | # interpreter is running with, so we can't do direct |
| 344 | # byte-compilation and be certain that it's the right thing. Thus, |
| 345 | # always compile indirectly if the current interpreter is in either |
| 346 | # optimize mode, or if either optimization level was requested by |
| 347 | # the caller. |
| 348 | if direct is None: |
| 349 | direct = (__debug__ and optimize == 0) |
| 350 | |
| 351 | # "Indirect" byte-compilation: write a temporary script and then |
| 352 | # run it with the appropriate flags. |
| 353 | if not direct: |
| 354 | from tempfile import mktemp |
| 355 | script_name = mktemp(".py") |
| 356 | if verbose: |
| 357 | print "writing byte-compilation script '%s'" % script_name |
| 358 | if not dry_run: |
| 359 | script = open(script_name, "w") |
| 360 | |
| 361 | script.write("""\ |
| 362 | from distutils.util import byte_compile |
| 363 | files = [ |
| 364 | """) |
Greg Ward | 9216cfe | 2000-10-03 03:31:05 +0000 | [diff] [blame] | 365 | |
| 366 | # XXX would be nice to write absolute filenames, just for |
| 367 | # safety's sake (script should be more robust in the face of |
| 368 | # chdir'ing before running it). But this requires abspath'ing |
| 369 | # 'prefix' as well, and that breaks the hack in build_lib's |
| 370 | # 'byte_compile()' method that carefully tacks on a trailing |
| 371 | # slash (os.sep really) to make sure the prefix here is "just |
| 372 | # right". This whole prefix business is rather delicate -- the |
| 373 | # problem is that it's really a directory, but I'm treating it |
| 374 | # as a dumb string, so trailing slashes and so forth matter. |
| 375 | |
| 376 | #py_files = map(os.path.abspath, py_files) |
| 377 | #if prefix: |
| 378 | # prefix = os.path.abspath(prefix) |
| 379 | |
Greg Ward | 1297b5c | 2000-09-30 20:37:56 +0000 | [diff] [blame] | 380 | script.write(string.join(map(repr, py_files), ",\n") + "]\n") |
| 381 | script.write(""" |
| 382 | byte_compile(files, optimize=%s, force=%s, |
| 383 | prefix=%s, base_dir=%s, |
| 384 | verbose=%s, dry_run=0, |
| 385 | direct=1) |
| 386 | """ % (`optimize`, `force`, `prefix`, `base_dir`, `verbose`)) |
| 387 | |
| 388 | script.close() |
| 389 | |
| 390 | cmd = [sys.executable, script_name] |
| 391 | if optimize == 1: |
| 392 | cmd.insert(1, "-O") |
| 393 | elif optimize == 2: |
| 394 | cmd.insert(1, "-OO") |
| 395 | spawn(cmd, verbose=verbose, dry_run=dry_run) |
Greg Ward | 9216cfe | 2000-10-03 03:31:05 +0000 | [diff] [blame] | 396 | execute(os.remove, (script_name,), "removing %s" % script_name, |
| 397 | verbose=verbose, dry_run=dry_run) |
Greg Ward | 1297b5c | 2000-09-30 20:37:56 +0000 | [diff] [blame] | 398 | |
| 399 | # "Direct" byte-compilation: use the py_compile module to compile |
| 400 | # right here, right now. Note that the script generated in indirect |
| 401 | # mode simply calls 'byte_compile()' in direct mode, a weird sort of |
| 402 | # cross-process recursion. Hey, it works! |
| 403 | else: |
| 404 | from py_compile import compile |
| 405 | |
| 406 | for file in py_files: |
| 407 | if file[-3:] != ".py": |
Greg Ward | f217e21 | 2000-10-01 23:49:30 +0000 | [diff] [blame] | 408 | # This lets us be lazy and not filter filenames in |
| 409 | # the "install_lib" command. |
| 410 | continue |
Greg Ward | 1297b5c | 2000-09-30 20:37:56 +0000 | [diff] [blame] | 411 | |
| 412 | # Terminology from the py_compile module: |
| 413 | # cfile - byte-compiled file |
| 414 | # dfile - purported source filename (same as 'file' by default) |
| 415 | cfile = file + (__debug__ and "c" or "o") |
| 416 | dfile = file |
| 417 | if prefix: |
| 418 | if file[:len(prefix)] != prefix: |
| 419 | raise ValueError, \ |
| 420 | ("invalid prefix: filename %s doesn't start with %s" |
| 421 | % (`file`, `prefix`)) |
| 422 | dfile = dfile[len(prefix):] |
| 423 | if base_dir: |
| 424 | dfile = os.path.join(base_dir, dfile) |
| 425 | |
| 426 | cfile_base = os.path.basename(cfile) |
| 427 | if direct: |
| 428 | if force or newer(file, cfile): |
| 429 | if verbose: |
| 430 | print "byte-compiling %s to %s" % (file, cfile_base) |
| 431 | if not dry_run: |
| 432 | compile(file, cfile, dfile) |
| 433 | else: |
| 434 | if verbose: |
| 435 | print "skipping byte-compilation of %s to %s" % \ |
| 436 | (file, cfile_base) |
| 437 | |
| 438 | # byte_compile () |