| 1 | """distutils.util
|
|---|
| 2 |
|
|---|
| 3 | Miscellaneous utility functions -- anything that doesn't fit into
|
|---|
| 4 | one of the other *util.py modules.
|
|---|
| 5 | """
|
|---|
| 6 |
|
|---|
| 7 | __revision__ = "$Id: util.py 77376 2010-01-08 23:27:23Z tarek.ziade $"
|
|---|
| 8 |
|
|---|
| 9 | import sys, os, string, re
|
|---|
| 10 | from distutils.errors import DistutilsPlatformError
|
|---|
| 11 | from distutils.dep_util import newer
|
|---|
| 12 | from distutils.spawn import spawn
|
|---|
| 13 | from distutils import log
|
|---|
| 14 | from distutils.errors import DistutilsByteCompileError
|
|---|
| 15 |
|
|---|
| 16 | def get_platform ():
|
|---|
| 17 | """Return a string that identifies the current platform. This is used
|
|---|
| 18 | mainly to distinguish platform-specific build directories and
|
|---|
| 19 | platform-specific built distributions. Typically includes the OS name
|
|---|
| 20 | and version and the architecture (as supplied by 'os.uname()'),
|
|---|
| 21 | although the exact information included depends on the OS; eg. for IRIX
|
|---|
| 22 | the architecture isn't particularly important (IRIX only runs on SGI
|
|---|
| 23 | hardware), but for Linux the kernel version isn't particularly
|
|---|
| 24 | important.
|
|---|
| 25 |
|
|---|
| 26 | Examples of returned values:
|
|---|
| 27 | linux-i586
|
|---|
| 28 | linux-alpha (?)
|
|---|
| 29 | solaris-2.6-sun4u
|
|---|
| 30 | irix-5.3
|
|---|
| 31 | irix64-6.2
|
|---|
| 32 |
|
|---|
| 33 | Windows will return one of:
|
|---|
| 34 | win-amd64 (64bit Windows on AMD64 (aka x86_64, Intel64, EM64T, etc)
|
|---|
| 35 | win-ia64 (64bit Windows on Itanium)
|
|---|
| 36 | win32 (all others - specifically, sys.platform is returned)
|
|---|
| 37 |
|
|---|
| 38 | For other non-POSIX platforms, currently just returns 'sys.platform'.
|
|---|
| 39 | """
|
|---|
| 40 | if os.name == 'nt':
|
|---|
| 41 | # sniff sys.version for architecture.
|
|---|
| 42 | prefix = " bit ("
|
|---|
| 43 | i = string.find(sys.version, prefix)
|
|---|
| 44 | if i == -1:
|
|---|
| 45 | return sys.platform
|
|---|
| 46 | j = string.find(sys.version, ")", i)
|
|---|
| 47 | look = sys.version[i+len(prefix):j].lower()
|
|---|
| 48 | if look=='amd64':
|
|---|
| 49 | return 'win-amd64'
|
|---|
| 50 | if look=='itanium':
|
|---|
| 51 | return 'win-ia64'
|
|---|
| 52 | return sys.platform
|
|---|
| 53 |
|
|---|
| 54 | if os.name != "posix" or not hasattr(os, 'uname'):
|
|---|
| 55 | # XXX what about the architecture? NT is Intel or Alpha,
|
|---|
| 56 | # Mac OS is M68k or PPC, etc.
|
|---|
| 57 | return sys.platform
|
|---|
| 58 |
|
|---|
| 59 | # Try to distinguish various flavours of Unix
|
|---|
| 60 |
|
|---|
| 61 | (osname, host, release, version, machine) = os.uname()
|
|---|
| 62 |
|
|---|
| 63 | # Convert the OS name to lowercase, remove '/' characters
|
|---|
| 64 | # (to accommodate BSD/OS), and translate spaces (for "Power Macintosh")
|
|---|
| 65 | osname = string.lower(osname)
|
|---|
| 66 | osname = string.replace(osname, '/', '')
|
|---|
| 67 | machine = string.replace(machine, ' ', '_')
|
|---|
| 68 | machine = string.replace(machine, '/', '-')
|
|---|
| 69 |
|
|---|
| 70 | if osname[:5] == "linux":
|
|---|
| 71 | # At least on Linux/Intel, 'machine' is the processor --
|
|---|
| 72 | # i386, etc.
|
|---|
| 73 | # XXX what about Alpha, SPARC, etc?
|
|---|
| 74 | return "%s-%s" % (osname, machine)
|
|---|
| 75 | elif osname[:5] == "sunos":
|
|---|
| 76 | if release[0] >= "5": # SunOS 5 == Solaris 2
|
|---|
| 77 | osname = "solaris"
|
|---|
| 78 | release = "%d.%s" % (int(release[0]) - 3, release[2:])
|
|---|
| 79 | # fall through to standard osname-release-machine representation
|
|---|
| 80 | elif osname[:4] == "irix": # could be "irix64"!
|
|---|
| 81 | return "%s-%s" % (osname, release)
|
|---|
| 82 | elif osname[:3] == "aix":
|
|---|
| 83 | return "%s-%s.%s" % (osname, version, release)
|
|---|
| 84 | elif osname[:6] == "cygwin":
|
|---|
| 85 | osname = "cygwin"
|
|---|
| 86 | rel_re = re.compile (r'[\d.]+')
|
|---|
| 87 | m = rel_re.match(release)
|
|---|
| 88 | if m:
|
|---|
| 89 | release = m.group()
|
|---|
| 90 | elif osname[:6] == "darwin":
|
|---|
| 91 | #
|
|---|
| 92 | # For our purposes, we'll assume that the system version from
|
|---|
| 93 | # distutils' perspective is what MACOSX_DEPLOYMENT_TARGET is set
|
|---|
| 94 | # to. This makes the compatibility story a bit more sane because the
|
|---|
| 95 | # machine is going to compile and link as if it were
|
|---|
| 96 | # MACOSX_DEPLOYMENT_TARGET.
|
|---|
| 97 | from distutils.sysconfig import get_config_vars
|
|---|
| 98 | cfgvars = get_config_vars()
|
|---|
| 99 |
|
|---|
| 100 | macver = os.environ.get('MACOSX_DEPLOYMENT_TARGET')
|
|---|
| 101 | if not macver:
|
|---|
| 102 | macver = cfgvars.get('MACOSX_DEPLOYMENT_TARGET')
|
|---|
| 103 |
|
|---|
| 104 | if 1:
|
|---|
| 105 | # Always calculate the release of the running machine,
|
|---|
| 106 | # needed to determine if we can build fat binaries or not.
|
|---|
| 107 |
|
|---|
| 108 | macrelease = macver
|
|---|
| 109 | # Get the system version. Reading this plist is a documented
|
|---|
| 110 | # way to get the system version (see the documentation for
|
|---|
| 111 | # the Gestalt Manager)
|
|---|
| 112 | try:
|
|---|
| 113 | f = open('/System/Library/CoreServices/SystemVersion.plist')
|
|---|
| 114 | except IOError:
|
|---|
| 115 | # We're on a plain darwin box, fall back to the default
|
|---|
| 116 | # behaviour.
|
|---|
| 117 | pass
|
|---|
| 118 | else:
|
|---|
| 119 | m = re.search(
|
|---|
| 120 | r'<key>ProductUserVisibleVersion</key>\s*' +
|
|---|
| 121 | r'<string>(.*?)</string>', f.read())
|
|---|
| 122 | f.close()
|
|---|
| 123 | if m is not None:
|
|---|
| 124 | macrelease = '.'.join(m.group(1).split('.')[:2])
|
|---|
| 125 | # else: fall back to the default behaviour
|
|---|
| 126 |
|
|---|
| 127 | if not macver:
|
|---|
| 128 | macver = macrelease
|
|---|
| 129 |
|
|---|
| 130 | if macver:
|
|---|
| 131 | from distutils.sysconfig import get_config_vars
|
|---|
| 132 | release = macver
|
|---|
| 133 | osname = "macosx"
|
|---|
| 134 |
|
|---|
| 135 | if (macrelease + '.') >= '10.4.' and \
|
|---|
| 136 | '-arch' in get_config_vars().get('CFLAGS', '').strip():
|
|---|
| 137 | # The universal build will build fat binaries, but not on
|
|---|
| 138 | # systems before 10.4
|
|---|
| 139 | #
|
|---|
| 140 | # Try to detect 4-way universal builds, those have machine-type
|
|---|
| 141 | # 'universal' instead of 'fat'.
|
|---|
| 142 |
|
|---|
| 143 | machine = 'fat'
|
|---|
| 144 | cflags = get_config_vars().get('CFLAGS')
|
|---|
| 145 |
|
|---|
| 146 | archs = re.findall('-arch\s+(\S+)', cflags)
|
|---|
| 147 | archs.sort()
|
|---|
| 148 | archs = tuple(archs)
|
|---|
| 149 |
|
|---|
| 150 | if len(archs) == 1:
|
|---|
| 151 | machine = archs[0]
|
|---|
| 152 | elif archs == ('i386', 'ppc'):
|
|---|
| 153 | machine = 'fat'
|
|---|
| 154 | elif archs == ('i386', 'x86_64'):
|
|---|
| 155 | machine = 'intel'
|
|---|
| 156 | elif archs == ('i386', 'ppc', 'x86_64'):
|
|---|
| 157 | machine = 'fat3'
|
|---|
| 158 | elif archs == ('ppc64', 'x86_64'):
|
|---|
| 159 | machine = 'fat64'
|
|---|
| 160 | elif archs == ('i386', 'ppc', 'ppc64', 'x86_64'):
|
|---|
| 161 | machine = 'universal'
|
|---|
| 162 | else:
|
|---|
| 163 | raise ValueError(
|
|---|
| 164 | "Don't know machine value for archs=%r"%(archs,))
|
|---|
| 165 |
|
|---|
| 166 | elif machine == 'i386':
|
|---|
| 167 | # On OSX the machine type returned by uname is always the
|
|---|
| 168 | # 32-bit variant, even if the executable architecture is
|
|---|
| 169 | # the 64-bit variant
|
|---|
| 170 | if sys.maxint >= 2**32:
|
|---|
| 171 | machine = 'x86_64'
|
|---|
| 172 |
|
|---|
| 173 | elif machine in ('PowerPC', 'Power_Macintosh'):
|
|---|
| 174 | # Pick a sane name for the PPC architecture.
|
|---|
| 175 | machine = 'ppc'
|
|---|
| 176 |
|
|---|
| 177 | # See 'i386' case
|
|---|
| 178 | if sys.maxint >= 2**32:
|
|---|
| 179 | machine = 'ppc64'
|
|---|
| 180 |
|
|---|
| 181 | return "%s-%s-%s" % (osname, release, machine)
|
|---|
| 182 |
|
|---|
| 183 | # get_platform ()
|
|---|
| 184 |
|
|---|
| 185 |
|
|---|
| 186 | def convert_path (pathname):
|
|---|
| 187 | """Return 'pathname' as a name that will work on the native filesystem,
|
|---|
| 188 | i.e. split it on '/' and put it back together again using the current
|
|---|
| 189 | directory separator. Needed because filenames in the setup script are
|
|---|
| 190 | always supplied in Unix style, and have to be converted to the local
|
|---|
| 191 | convention before we can actually use them in the filesystem. Raises
|
|---|
| 192 | ValueError on non-Unix-ish systems if 'pathname' either starts or
|
|---|
| 193 | ends with a slash.
|
|---|
| 194 | """
|
|---|
| 195 | if os.sep == '/':
|
|---|
| 196 | return pathname
|
|---|
| 197 | if not pathname:
|
|---|
| 198 | return pathname
|
|---|
| 199 | if pathname[0] == '/':
|
|---|
| 200 | raise ValueError, "path '%s' cannot be absolute" % pathname
|
|---|
| 201 | if pathname[-1] == '/':
|
|---|
| 202 | raise ValueError, "path '%s' cannot end with '/'" % pathname
|
|---|
| 203 |
|
|---|
| 204 | paths = string.split(pathname, '/')
|
|---|
| 205 | while '.' in paths:
|
|---|
| 206 | paths.remove('.')
|
|---|
| 207 | if not paths:
|
|---|
| 208 | return os.curdir
|
|---|
| 209 | return apply(os.path.join, paths)
|
|---|
| 210 |
|
|---|
| 211 | # convert_path ()
|
|---|
| 212 |
|
|---|
| 213 |
|
|---|
| 214 | def change_root (new_root, pathname):
|
|---|
| 215 | """Return 'pathname' with 'new_root' prepended. If 'pathname' is
|
|---|
| 216 | relative, this is equivalent to "os.path.join(new_root,pathname)".
|
|---|
| 217 | Otherwise, it requires making 'pathname' relative and then joining the
|
|---|
| 218 | two, which is tricky on DOS/Windows and Mac OS.
|
|---|
| 219 | """
|
|---|
| 220 | if new_root is None or new_root == '':
|
|---|
| 221 | return pathname
|
|---|
| 222 |
|
|---|
| 223 | if os.name == 'posix':
|
|---|
| 224 | if not os.path.isabs(pathname):
|
|---|
| 225 | return os.path.join(new_root, pathname)
|
|---|
| 226 | else:
|
|---|
| 227 | return os.path.join(new_root, pathname[1:])
|
|---|
| 228 |
|
|---|
| 229 | elif os.name == 'nt':
|
|---|
| 230 | (drive, path) = os.path.splitdrive(pathname)
|
|---|
| 231 | if path[0] == '\\':
|
|---|
| 232 | path = path[1:]
|
|---|
| 233 | return os.path.join(new_root, path)
|
|---|
| 234 |
|
|---|
| 235 | elif os.name == 'os2':
|
|---|
| 236 | (drive, path) = os.path.splitdrive(pathname)
|
|---|
| 237 | if path[0] == os.sep:
|
|---|
| 238 | path = path[1:]
|
|---|
| 239 | return os.path.join(new_root, path)
|
|---|
| 240 |
|
|---|
| 241 | elif os.name == 'mac':
|
|---|
| 242 | if not os.path.isabs(pathname):
|
|---|
| 243 | return os.path.join(new_root, pathname)
|
|---|
| 244 | else:
|
|---|
| 245 | # Chop off volume name from start of path
|
|---|
| 246 | elements = string.split(pathname, ":", 1)
|
|---|
| 247 | pathname = ":" + elements[1]
|
|---|
| 248 | return os.path.join(new_root, pathname)
|
|---|
| 249 |
|
|---|
| 250 | else:
|
|---|
| 251 | raise DistutilsPlatformError, \
|
|---|
| 252 | "nothing known about platform '%s'" % os.name
|
|---|
| 253 |
|
|---|
| 254 |
|
|---|
| 255 | _environ_checked = 0
|
|---|
| 256 | def check_environ ():
|
|---|
| 257 | """Ensure that 'os.environ' has all the environment variables we
|
|---|
| 258 | guarantee that users can use in config files, command-line options,
|
|---|
| 259 | etc. Currently this includes:
|
|---|
| 260 | HOME - user's home directory (Unix only)
|
|---|
| 261 | PLAT - description of the current platform, including hardware
|
|---|
| 262 | and OS (see 'get_platform()')
|
|---|
| 263 | """
|
|---|
| 264 | global _environ_checked
|
|---|
| 265 | if _environ_checked:
|
|---|
| 266 | return
|
|---|
| 267 |
|
|---|
| 268 | if os.name == 'posix' and 'HOME' not in os.environ:
|
|---|
| 269 | import pwd
|
|---|
| 270 | os.environ['HOME'] = pwd.getpwuid(os.getuid())[5]
|
|---|
| 271 |
|
|---|
| 272 | if 'PLAT' not in os.environ:
|
|---|
| 273 | os.environ['PLAT'] = get_platform()
|
|---|
| 274 |
|
|---|
| 275 | _environ_checked = 1
|
|---|
| 276 |
|
|---|
| 277 |
|
|---|
| 278 | def subst_vars (s, local_vars):
|
|---|
| 279 | """Perform shell/Perl-style variable substitution on 'string'. Every
|
|---|
| 280 | occurrence of '$' followed by a name is considered a variable, and
|
|---|
| 281 | variable is substituted by the value found in the 'local_vars'
|
|---|
| 282 | dictionary, or in 'os.environ' if it's not in 'local_vars'.
|
|---|
| 283 | 'os.environ' is first checked/augmented to guarantee that it contains
|
|---|
| 284 | certain values: see 'check_environ()'. Raise ValueError for any
|
|---|
| 285 | variables not found in either 'local_vars' or 'os.environ'.
|
|---|
| 286 | """
|
|---|
| 287 | check_environ()
|
|---|
| 288 | def _subst (match, local_vars=local_vars):
|
|---|
| 289 | var_name = match.group(1)
|
|---|
| 290 | if var_name in local_vars:
|
|---|
| 291 | return str(local_vars[var_name])
|
|---|
| 292 | else:
|
|---|
| 293 | return os.environ[var_name]
|
|---|
| 294 |
|
|---|
| 295 | try:
|
|---|
| 296 | return re.sub(r'\$([a-zA-Z_][a-zA-Z_0-9]*)', _subst, s)
|
|---|
| 297 | except KeyError, var:
|
|---|
| 298 | raise ValueError, "invalid variable '$%s'" % var
|
|---|
| 299 |
|
|---|
| 300 | # subst_vars ()
|
|---|
| 301 |
|
|---|
| 302 |
|
|---|
| 303 | def grok_environment_error (exc, prefix="error: "):
|
|---|
| 304 | """Generate a useful error message from an EnvironmentError (IOError or
|
|---|
| 305 | OSError) exception object. Handles Python 1.5.1 and 1.5.2 styles, and
|
|---|
| 306 | does what it can to deal with exception objects that don't have a
|
|---|
| 307 | filename (which happens when the error is due to a two-file operation,
|
|---|
| 308 | such as 'rename()' or 'link()'. Returns the error message as a string
|
|---|
| 309 | prefixed with 'prefix'.
|
|---|
| 310 | """
|
|---|
| 311 | # check for Python 1.5.2-style {IO,OS}Error exception objects
|
|---|
| 312 | if hasattr(exc, 'filename') and hasattr(exc, 'strerror'):
|
|---|
| 313 | if exc.filename:
|
|---|
| 314 | error = prefix + "%s: %s" % (exc.filename, exc.strerror)
|
|---|
| 315 | else:
|
|---|
| 316 | # two-argument functions in posix module don't
|
|---|
| 317 | # include the filename in the exception object!
|
|---|
| 318 | error = prefix + "%s" % exc.strerror
|
|---|
| 319 | else:
|
|---|
| 320 | error = prefix + str(exc[-1])
|
|---|
| 321 |
|
|---|
| 322 | return error
|
|---|
| 323 |
|
|---|
| 324 |
|
|---|
| 325 | # Needed by 'split_quoted()'
|
|---|
| 326 | _wordchars_re = _squote_re = _dquote_re = None
|
|---|
| 327 | def _init_regex():
|
|---|
| 328 | global _wordchars_re, _squote_re, _dquote_re
|
|---|
| 329 | _wordchars_re = re.compile(r'[^\\\'\"%s ]*' % string.whitespace)
|
|---|
| 330 | _squote_re = re.compile(r"'(?:[^'\\]|\\.)*'")
|
|---|
| 331 | _dquote_re = re.compile(r'"(?:[^"\\]|\\.)*"')
|
|---|
| 332 |
|
|---|
| 333 | def split_quoted (s):
|
|---|
| 334 | """Split a string up according to Unix shell-like rules for quotes and
|
|---|
| 335 | backslashes. In short: words are delimited by spaces, as long as those
|
|---|
| 336 | spaces are not escaped by a backslash, or inside a quoted string.
|
|---|
| 337 | Single and double quotes are equivalent, and the quote characters can
|
|---|
| 338 | be backslash-escaped. The backslash is stripped from any two-character
|
|---|
| 339 | escape sequence, leaving only the escaped character. The quote
|
|---|
| 340 | characters are stripped from any quoted string. Returns a list of
|
|---|
| 341 | words.
|
|---|
| 342 | """
|
|---|
| 343 |
|
|---|
| 344 | # This is a nice algorithm for splitting up a single string, since it
|
|---|
| 345 | # doesn't require character-by-character examination. It was a little
|
|---|
| 346 | # bit of a brain-bender to get it working right, though...
|
|---|
| 347 | if _wordchars_re is None: _init_regex()
|
|---|
| 348 |
|
|---|
| 349 | s = string.strip(s)
|
|---|
| 350 | words = []
|
|---|
| 351 | pos = 0
|
|---|
| 352 |
|
|---|
| 353 | while s:
|
|---|
| 354 | m = _wordchars_re.match(s, pos)
|
|---|
| 355 | end = m.end()
|
|---|
| 356 | if end == len(s):
|
|---|
| 357 | words.append(s[:end])
|
|---|
| 358 | break
|
|---|
| 359 |
|
|---|
| 360 | if s[end] in string.whitespace: # unescaped, unquoted whitespace: now
|
|---|
| 361 | words.append(s[:end]) # we definitely have a word delimiter
|
|---|
| 362 | s = string.lstrip(s[end:])
|
|---|
| 363 | pos = 0
|
|---|
| 364 |
|
|---|
| 365 | elif s[end] == '\\': # preserve whatever is being escaped;
|
|---|
| 366 | # will become part of the current word
|
|---|
| 367 | s = s[:end] + s[end+1:]
|
|---|
| 368 | pos = end+1
|
|---|
| 369 |
|
|---|
| 370 | else:
|
|---|
| 371 | if s[end] == "'": # slurp singly-quoted string
|
|---|
| 372 | m = _squote_re.match(s, end)
|
|---|
| 373 | elif s[end] == '"': # slurp doubly-quoted string
|
|---|
| 374 | m = _dquote_re.match(s, end)
|
|---|
| 375 | else:
|
|---|
| 376 | raise RuntimeError, \
|
|---|
| 377 | "this can't happen (bad char '%c')" % s[end]
|
|---|
| 378 |
|
|---|
| 379 | if m is None:
|
|---|
| 380 | raise ValueError, \
|
|---|
| 381 | "bad string (mismatched %s quotes?)" % s[end]
|
|---|
| 382 |
|
|---|
| 383 | (beg, end) = m.span()
|
|---|
| 384 | s = s[:beg] + s[beg+1:end-1] + s[end:]
|
|---|
| 385 | pos = m.end() - 2
|
|---|
| 386 |
|
|---|
| 387 | if pos >= len(s):
|
|---|
| 388 | words.append(s)
|
|---|
| 389 | break
|
|---|
| 390 |
|
|---|
| 391 | return words
|
|---|
| 392 |
|
|---|
| 393 | # split_quoted ()
|
|---|
| 394 |
|
|---|
| 395 |
|
|---|
| 396 | def execute (func, args, msg=None, verbose=0, dry_run=0):
|
|---|
| 397 | """Perform some action that affects the outside world (eg. by
|
|---|
| 398 | writing to the filesystem). Such actions are special because they
|
|---|
| 399 | are disabled by the 'dry_run' flag. This method takes care of all
|
|---|
| 400 | that bureaucracy for you; all you have to do is supply the
|
|---|
| 401 | function to call and an argument tuple for it (to embody the
|
|---|
| 402 | "external action" being performed), and an optional message to
|
|---|
| 403 | print.
|
|---|
| 404 | """
|
|---|
| 405 | if msg is None:
|
|---|
| 406 | msg = "%s%r" % (func.__name__, args)
|
|---|
| 407 | if msg[-2:] == ',)': # correct for singleton tuple
|
|---|
| 408 | msg = msg[0:-2] + ')'
|
|---|
| 409 |
|
|---|
| 410 | log.info(msg)
|
|---|
| 411 | if not dry_run:
|
|---|
| 412 | apply(func, args)
|
|---|
| 413 |
|
|---|
| 414 |
|
|---|
| 415 | def strtobool (val):
|
|---|
| 416 | """Convert a string representation of truth to true (1) or false (0).
|
|---|
| 417 |
|
|---|
| 418 | True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values
|
|---|
| 419 | are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if
|
|---|
| 420 | 'val' is anything else.
|
|---|
| 421 | """
|
|---|
| 422 | val = string.lower(val)
|
|---|
| 423 | if val in ('y', 'yes', 't', 'true', 'on', '1'):
|
|---|
| 424 | return 1
|
|---|
| 425 | elif val in ('n', 'no', 'f', 'false', 'off', '0'):
|
|---|
| 426 | return 0
|
|---|
| 427 | else:
|
|---|
| 428 | raise ValueError, "invalid truth value %r" % (val,)
|
|---|
| 429 |
|
|---|
| 430 |
|
|---|
| 431 | def byte_compile (py_files,
|
|---|
| 432 | optimize=0, force=0,
|
|---|
| 433 | prefix=None, base_dir=None,
|
|---|
| 434 | verbose=1, dry_run=0,
|
|---|
| 435 | direct=None):
|
|---|
| 436 | """Byte-compile a collection of Python source files to either .pyc
|
|---|
| 437 | or .pyo files in the same directory. 'py_files' is a list of files
|
|---|
| 438 | to compile; any files that don't end in ".py" are silently skipped.
|
|---|
| 439 | 'optimize' must be one of the following:
|
|---|
| 440 | 0 - don't optimize (generate .pyc)
|
|---|
| 441 | 1 - normal optimization (like "python -O")
|
|---|
| 442 | 2 - extra optimization (like "python -OO")
|
|---|
| 443 | If 'force' is true, all files are recompiled regardless of
|
|---|
| 444 | timestamps.
|
|---|
| 445 |
|
|---|
| 446 | The source filename encoded in each bytecode file defaults to the
|
|---|
| 447 | filenames listed in 'py_files'; you can modify these with 'prefix' and
|
|---|
| 448 | 'basedir'. 'prefix' is a string that will be stripped off of each
|
|---|
| 449 | source filename, and 'base_dir' is a directory name that will be
|
|---|
| 450 | prepended (after 'prefix' is stripped). You can supply either or both
|
|---|
| 451 | (or neither) of 'prefix' and 'base_dir', as you wish.
|
|---|
| 452 |
|
|---|
| 453 | If 'dry_run' is true, doesn't actually do anything that would
|
|---|
| 454 | affect the filesystem.
|
|---|
| 455 |
|
|---|
| 456 | Byte-compilation is either done directly in this interpreter process
|
|---|
| 457 | with the standard py_compile module, or indirectly by writing a
|
|---|
| 458 | temporary script and executing it. Normally, you should let
|
|---|
| 459 | 'byte_compile()' figure out to use direct compilation or not (see
|
|---|
| 460 | the source for details). The 'direct' flag is used by the script
|
|---|
| 461 | generated in indirect mode; unless you know what you're doing, leave
|
|---|
| 462 | it set to None.
|
|---|
| 463 | """
|
|---|
| 464 | # nothing is done if sys.dont_write_bytecode is True
|
|---|
| 465 | if sys.dont_write_bytecode:
|
|---|
| 466 | raise DistutilsByteCompileError('byte-compiling is disabled.')
|
|---|
| 467 |
|
|---|
| 468 | # First, if the caller didn't force us into direct or indirect mode,
|
|---|
| 469 | # figure out which mode we should be in. We take a conservative
|
|---|
| 470 | # approach: choose direct mode *only* if the current interpreter is
|
|---|
| 471 | # in debug mode and optimize is 0. If we're not in debug mode (-O
|
|---|
| 472 | # or -OO), we don't know which level of optimization this
|
|---|
| 473 | # interpreter is running with, so we can't do direct
|
|---|
| 474 | # byte-compilation and be certain that it's the right thing. Thus,
|
|---|
| 475 | # always compile indirectly if the current interpreter is in either
|
|---|
| 476 | # optimize mode, or if either optimization level was requested by
|
|---|
| 477 | # the caller.
|
|---|
| 478 | if direct is None:
|
|---|
| 479 | direct = (__debug__ and optimize == 0)
|
|---|
| 480 |
|
|---|
| 481 | # "Indirect" byte-compilation: write a temporary script and then
|
|---|
| 482 | # run it with the appropriate flags.
|
|---|
| 483 | if not direct:
|
|---|
| 484 | try:
|
|---|
| 485 | from tempfile import mkstemp
|
|---|
| 486 | (script_fd, script_name) = mkstemp(".py")
|
|---|
| 487 | except ImportError:
|
|---|
| 488 | from tempfile import mktemp
|
|---|
| 489 | (script_fd, script_name) = None, mktemp(".py")
|
|---|
| 490 | log.info("writing byte-compilation script '%s'", script_name)
|
|---|
| 491 | if not dry_run:
|
|---|
| 492 | if script_fd is not None:
|
|---|
| 493 | script = os.fdopen(script_fd, "w")
|
|---|
| 494 | else:
|
|---|
| 495 | script = open(script_name, "w")
|
|---|
| 496 |
|
|---|
| 497 | script.write("""\
|
|---|
| 498 | from distutils.util import byte_compile
|
|---|
| 499 | files = [
|
|---|
| 500 | """)
|
|---|
| 501 |
|
|---|
| 502 | # XXX would be nice to write absolute filenames, just for
|
|---|
| 503 | # safety's sake (script should be more robust in the face of
|
|---|
| 504 | # chdir'ing before running it). But this requires abspath'ing
|
|---|
| 505 | # 'prefix' as well, and that breaks the hack in build_lib's
|
|---|
| 506 | # 'byte_compile()' method that carefully tacks on a trailing
|
|---|
| 507 | # slash (os.sep really) to make sure the prefix here is "just
|
|---|
| 508 | # right". This whole prefix business is rather delicate -- the
|
|---|
| 509 | # problem is that it's really a directory, but I'm treating it
|
|---|
| 510 | # as a dumb string, so trailing slashes and so forth matter.
|
|---|
| 511 |
|
|---|
| 512 | #py_files = map(os.path.abspath, py_files)
|
|---|
| 513 | #if prefix:
|
|---|
| 514 | # prefix = os.path.abspath(prefix)
|
|---|
| 515 |
|
|---|
| 516 | script.write(string.join(map(repr, py_files), ",\n") + "]\n")
|
|---|
| 517 | script.write("""
|
|---|
| 518 | byte_compile(files, optimize=%r, force=%r,
|
|---|
| 519 | prefix=%r, base_dir=%r,
|
|---|
| 520 | verbose=%r, dry_run=0,
|
|---|
| 521 | direct=1)
|
|---|
| 522 | """ % (optimize, force, prefix, base_dir, verbose))
|
|---|
| 523 |
|
|---|
| 524 | script.close()
|
|---|
| 525 |
|
|---|
| 526 | cmd = [sys.executable, script_name]
|
|---|
| 527 | if optimize == 1:
|
|---|
| 528 | cmd.insert(1, "-O")
|
|---|
| 529 | elif optimize == 2:
|
|---|
| 530 | cmd.insert(1, "-OO")
|
|---|
| 531 | spawn(cmd, dry_run=dry_run)
|
|---|
| 532 | execute(os.remove, (script_name,), "removing %s" % script_name,
|
|---|
| 533 | dry_run=dry_run)
|
|---|
| 534 |
|
|---|
| 535 | # "Direct" byte-compilation: use the py_compile module to compile
|
|---|
| 536 | # right here, right now. Note that the script generated in indirect
|
|---|
| 537 | # mode simply calls 'byte_compile()' in direct mode, a weird sort of
|
|---|
| 538 | # cross-process recursion. Hey, it works!
|
|---|
| 539 | else:
|
|---|
| 540 | from py_compile import compile
|
|---|
| 541 |
|
|---|
| 542 | for file in py_files:
|
|---|
| 543 | if file[-3:] != ".py":
|
|---|
| 544 | # This lets us be lazy and not filter filenames in
|
|---|
| 545 | # the "install_lib" command.
|
|---|
| 546 | continue
|
|---|
| 547 |
|
|---|
| 548 | # Terminology from the py_compile module:
|
|---|
| 549 | # cfile - byte-compiled file
|
|---|
| 550 | # dfile - purported source filename (same as 'file' by default)
|
|---|
| 551 | cfile = file + (__debug__ and "c" or "o")
|
|---|
| 552 | dfile = file
|
|---|
| 553 | if prefix:
|
|---|
| 554 | if file[:len(prefix)] != prefix:
|
|---|
| 555 | raise ValueError, \
|
|---|
| 556 | ("invalid prefix: filename %r doesn't start with %r"
|
|---|
| 557 | % (file, prefix))
|
|---|
| 558 | dfile = dfile[len(prefix):]
|
|---|
| 559 | if base_dir:
|
|---|
| 560 | dfile = os.path.join(base_dir, dfile)
|
|---|
| 561 |
|
|---|
| 562 | cfile_base = os.path.basename(cfile)
|
|---|
| 563 | if direct:
|
|---|
| 564 | if force or newer(file, cfile):
|
|---|
| 565 | log.info("byte-compiling %s to %s", file, cfile_base)
|
|---|
| 566 | if not dry_run:
|
|---|
| 567 | compile(file, cfile, dfile)
|
|---|
| 568 | else:
|
|---|
| 569 | log.debug("skipping byte-compilation of %s to %s",
|
|---|
| 570 | file, cfile_base)
|
|---|
| 571 |
|
|---|
| 572 | # byte_compile ()
|
|---|
| 573 |
|
|---|
| 574 | def rfc822_escape (header):
|
|---|
| 575 | """Return a version of the string escaped for inclusion in an
|
|---|
| 576 | RFC-822 header, by ensuring there are 8 spaces space after each newline.
|
|---|
| 577 | """
|
|---|
| 578 | lines = string.split(header, '\n')
|
|---|
| 579 | header = string.join(lines, '\n' + 8*' ')
|
|---|
| 580 | return header
|
|---|
