source: python/vendor/Python-2.7.6/Lib/distutils/util.py

Last change on this file was 388, checked in by dmik, 11 years ago

python: Update vendor to 2.7.6.

  • Property svn:eol-style set to native
File size: 18.3 KB
Line 
1"""distutils.util
2
3Miscellaneous utility functions -- anything that doesn't fit into
4one of the other *util.py modules.
5"""
6
7__revision__ = "$Id$"
8
9import sys, os, string, re
10from distutils.errors import DistutilsPlatformError
11from distutils.dep_util import newer
12from distutils.spawn import spawn
13from distutils import log
14from distutils.errors import DistutilsByteCompileError
15
16def 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 # Set for cross builds explicitly
55 if "_PYTHON_HOST_PLATFORM" in os.environ:
56 return os.environ["_PYTHON_HOST_PLATFORM"]
57
58 if os.name != "posix" or not hasattr(os, 'uname'):
59 # XXX what about the architecture? NT is Intel or Alpha,
60 # Mac OS is M68k or PPC, etc.
61 return sys.platform
62
63 # Try to distinguish various flavours of Unix
64
65 (osname, host, release, version, machine) = os.uname()
66
67 # Convert the OS name to lowercase, remove '/' characters
68 # (to accommodate BSD/OS), and translate spaces (for "Power Macintosh")
69 osname = string.lower(osname)
70 osname = string.replace(osname, '/', '')
71 machine = string.replace(machine, ' ', '_')
72 machine = string.replace(machine, '/', '-')
73
74 if osname[:5] == "linux":
75 # At least on Linux/Intel, 'machine' is the processor --
76 # i386, etc.
77 # XXX what about Alpha, SPARC, etc?
78 return "%s-%s" % (osname, machine)
79 elif osname[:5] == "sunos":
80 if release[0] >= "5": # SunOS 5 == Solaris 2
81 osname = "solaris"
82 release = "%d.%s" % (int(release[0]) - 3, release[2:])
83 # We can't use "platform.architecture()[0]" because a
84 # bootstrap problem. We use a dict to get an error
85 # if some suspicious happens.
86 bitness = {2147483647:"32bit", 9223372036854775807:"64bit"}
87 machine += ".%s" % bitness[sys.maxint]
88 # fall through to standard osname-release-machine representation
89 elif osname[:4] == "irix": # could be "irix64"!
90 return "%s-%s" % (osname, release)
91 elif osname[:3] == "aix":
92 return "%s-%s.%s" % (osname, version, release)
93 elif osname[:6] == "cygwin":
94 osname = "cygwin"
95 rel_re = re.compile (r'[\d.]+')
96 m = rel_re.match(release)
97 if m:
98 release = m.group()
99 elif osname[:6] == "darwin":
100 import _osx_support, distutils.sysconfig
101 osname, release, machine = _osx_support.get_platform_osx(
102 distutils.sysconfig.get_config_vars(),
103 osname, release, machine)
104
105 return "%s-%s-%s" % (osname, release, machine)
106
107# get_platform ()
108
109
110def convert_path (pathname):
111 """Return 'pathname' as a name that will work on the native filesystem,
112 i.e. split it on '/' and put it back together again using the current
113 directory separator. Needed because filenames in the setup script are
114 always supplied in Unix style, and have to be converted to the local
115 convention before we can actually use them in the filesystem. Raises
116 ValueError on non-Unix-ish systems if 'pathname' either starts or
117 ends with a slash.
118 """
119 if os.sep == '/':
120 return pathname
121 if not pathname:
122 return pathname
123 if pathname[0] == '/':
124 raise ValueError, "path '%s' cannot be absolute" % pathname
125 if pathname[-1] == '/':
126 raise ValueError, "path '%s' cannot end with '/'" % pathname
127
128 paths = string.split(pathname, '/')
129 while '.' in paths:
130 paths.remove('.')
131 if not paths:
132 return os.curdir
133 return os.path.join(*paths)
134
135# convert_path ()
136
137
138def change_root (new_root, pathname):
139 """Return 'pathname' with 'new_root' prepended. If 'pathname' is
140 relative, this is equivalent to "os.path.join(new_root,pathname)".
141 Otherwise, it requires making 'pathname' relative and then joining the
142 two, which is tricky on DOS/Windows and Mac OS.
143 """
144 if os.name == 'posix':
145 if not os.path.isabs(pathname):
146 return os.path.join(new_root, pathname)
147 else:
148 return os.path.join(new_root, pathname[1:])
149
150 elif os.name == 'nt':
151 (drive, path) = os.path.splitdrive(pathname)
152 if path[0] == '\\':
153 path = path[1:]
154 return os.path.join(new_root, path)
155
156 elif os.name == 'os2':
157 (drive, path) = os.path.splitdrive(pathname)
158 if path[0] == os.sep:
159 path = path[1:]
160 return os.path.join(new_root, path)
161
162 else:
163 raise DistutilsPlatformError, \
164 "nothing known about platform '%s'" % os.name
165
166
167_environ_checked = 0
168def check_environ ():
169 """Ensure that 'os.environ' has all the environment variables we
170 guarantee that users can use in config files, command-line options,
171 etc. Currently this includes:
172 HOME - user's home directory (Unix only)
173 PLAT - description of the current platform, including hardware
174 and OS (see 'get_platform()')
175 """
176 global _environ_checked
177 if _environ_checked:
178 return
179
180 if os.name == 'posix' and 'HOME' not in os.environ:
181 import pwd
182 os.environ['HOME'] = pwd.getpwuid(os.getuid())[5]
183
184 if 'PLAT' not in os.environ:
185 os.environ['PLAT'] = get_platform()
186
187 _environ_checked = 1
188
189
190def subst_vars (s, local_vars):
191 """Perform shell/Perl-style variable substitution on 'string'. Every
192 occurrence of '$' followed by a name is considered a variable, and
193 variable is substituted by the value found in the 'local_vars'
194 dictionary, or in 'os.environ' if it's not in 'local_vars'.
195 'os.environ' is first checked/augmented to guarantee that it contains
196 certain values: see 'check_environ()'. Raise ValueError for any
197 variables not found in either 'local_vars' or 'os.environ'.
198 """
199 check_environ()
200 def _subst (match, local_vars=local_vars):
201 var_name = match.group(1)
202 if var_name in local_vars:
203 return str(local_vars[var_name])
204 else:
205 return os.environ[var_name]
206
207 try:
208 return re.sub(r'\$([a-zA-Z_][a-zA-Z_0-9]*)', _subst, s)
209 except KeyError, var:
210 raise ValueError, "invalid variable '$%s'" % var
211
212# subst_vars ()
213
214
215def grok_environment_error (exc, prefix="error: "):
216 """Generate a useful error message from an EnvironmentError (IOError or
217 OSError) exception object. Handles Python 1.5.1 and 1.5.2 styles, and
218 does what it can to deal with exception objects that don't have a
219 filename (which happens when the error is due to a two-file operation,
220 such as 'rename()' or 'link()'. Returns the error message as a string
221 prefixed with 'prefix'.
222 """
223 # check for Python 1.5.2-style {IO,OS}Error exception objects
224 if hasattr(exc, 'filename') and hasattr(exc, 'strerror'):
225 if exc.filename:
226 error = prefix + "%s: %s" % (exc.filename, exc.strerror)
227 else:
228 # two-argument functions in posix module don't
229 # include the filename in the exception object!
230 error = prefix + "%s" % exc.strerror
231 else:
232 error = prefix + str(exc[-1])
233
234 return error
235
236
237# Needed by 'split_quoted()'
238_wordchars_re = _squote_re = _dquote_re = None
239def _init_regex():
240 global _wordchars_re, _squote_re, _dquote_re
241 _wordchars_re = re.compile(r'[^\\\'\"%s ]*' % string.whitespace)
242 _squote_re = re.compile(r"'(?:[^'\\]|\\.)*'")
243 _dquote_re = re.compile(r'"(?:[^"\\]|\\.)*"')
244
245def split_quoted (s):
246 """Split a string up according to Unix shell-like rules for quotes and
247 backslashes. In short: words are delimited by spaces, as long as those
248 spaces are not escaped by a backslash, or inside a quoted string.
249 Single and double quotes are equivalent, and the quote characters can
250 be backslash-escaped. The backslash is stripped from any two-character
251 escape sequence, leaving only the escaped character. The quote
252 characters are stripped from any quoted string. Returns a list of
253 words.
254 """
255
256 # This is a nice algorithm for splitting up a single string, since it
257 # doesn't require character-by-character examination. It was a little
258 # bit of a brain-bender to get it working right, though...
259 if _wordchars_re is None: _init_regex()
260
261 s = string.strip(s)
262 words = []
263 pos = 0
264
265 while s:
266 m = _wordchars_re.match(s, pos)
267 end = m.end()
268 if end == len(s):
269 words.append(s[:end])
270 break
271
272 if s[end] in string.whitespace: # unescaped, unquoted whitespace: now
273 words.append(s[:end]) # we definitely have a word delimiter
274 s = string.lstrip(s[end:])
275 pos = 0
276
277 elif s[end] == '\\': # preserve whatever is being escaped;
278 # will become part of the current word
279 s = s[:end] + s[end+1:]
280 pos = end+1
281
282 else:
283 if s[end] == "'": # slurp singly-quoted string
284 m = _squote_re.match(s, end)
285 elif s[end] == '"': # slurp doubly-quoted string
286 m = _dquote_re.match(s, end)
287 else:
288 raise RuntimeError, \
289 "this can't happen (bad char '%c')" % s[end]
290
291 if m is None:
292 raise ValueError, \
293 "bad string (mismatched %s quotes?)" % s[end]
294
295 (beg, end) = m.span()
296 s = s[:beg] + s[beg+1:end-1] + s[end:]
297 pos = m.end() - 2
298
299 if pos >= len(s):
300 words.append(s)
301 break
302
303 return words
304
305# split_quoted ()
306
307
308def execute (func, args, msg=None, verbose=0, dry_run=0):
309 """Perform some action that affects the outside world (eg. by
310 writing to the filesystem). Such actions are special because they
311 are disabled by the 'dry_run' flag. This method takes care of all
312 that bureaucracy for you; all you have to do is supply the
313 function to call and an argument tuple for it (to embody the
314 "external action" being performed), and an optional message to
315 print.
316 """
317 if msg is None:
318 msg = "%s%r" % (func.__name__, args)
319 if msg[-2:] == ',)': # correct for singleton tuple
320 msg = msg[0:-2] + ')'
321
322 log.info(msg)
323 if not dry_run:
324 func(*args)
325
326
327def strtobool (val):
328 """Convert a string representation of truth to true (1) or false (0).
329
330 True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values
331 are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if
332 'val' is anything else.
333 """
334 val = string.lower(val)
335 if val in ('y', 'yes', 't', 'true', 'on', '1'):
336 return 1
337 elif val in ('n', 'no', 'f', 'false', 'off', '0'):
338 return 0
339 else:
340 raise ValueError, "invalid truth value %r" % (val,)
341
342
343def byte_compile (py_files,
344 optimize=0, force=0,
345 prefix=None, base_dir=None,
346 verbose=1, dry_run=0,
347 direct=None):
348 """Byte-compile a collection of Python source files to either .pyc
349 or .pyo files in the same directory. 'py_files' is a list of files
350 to compile; any files that don't end in ".py" are silently skipped.
351 'optimize' must be one of the following:
352 0 - don't optimize (generate .pyc)
353 1 - normal optimization (like "python -O")
354 2 - extra optimization (like "python -OO")
355 If 'force' is true, all files are recompiled regardless of
356 timestamps.
357
358 The source filename encoded in each bytecode file defaults to the
359 filenames listed in 'py_files'; you can modify these with 'prefix' and
360 'basedir'. 'prefix' is a string that will be stripped off of each
361 source filename, and 'base_dir' is a directory name that will be
362 prepended (after 'prefix' is stripped). You can supply either or both
363 (or neither) of 'prefix' and 'base_dir', as you wish.
364
365 If 'dry_run' is true, doesn't actually do anything that would
366 affect the filesystem.
367
368 Byte-compilation is either done directly in this interpreter process
369 with the standard py_compile module, or indirectly by writing a
370 temporary script and executing it. Normally, you should let
371 'byte_compile()' figure out to use direct compilation or not (see
372 the source for details). The 'direct' flag is used by the script
373 generated in indirect mode; unless you know what you're doing, leave
374 it set to None.
375 """
376 # nothing is done if sys.dont_write_bytecode is True
377 if sys.dont_write_bytecode:
378 raise DistutilsByteCompileError('byte-compiling is disabled.')
379
380 # First, if the caller didn't force us into direct or indirect mode,
381 # figure out which mode we should be in. We take a conservative
382 # approach: choose direct mode *only* if the current interpreter is
383 # in debug mode and optimize is 0. If we're not in debug mode (-O
384 # or -OO), we don't know which level of optimization this
385 # interpreter is running with, so we can't do direct
386 # byte-compilation and be certain that it's the right thing. Thus,
387 # always compile indirectly if the current interpreter is in either
388 # optimize mode, or if either optimization level was requested by
389 # the caller.
390 if direct is None:
391 direct = (__debug__ and optimize == 0)
392
393 # "Indirect" byte-compilation: write a temporary script and then
394 # run it with the appropriate flags.
395 if not direct:
396 try:
397 from tempfile import mkstemp
398 (script_fd, script_name) = mkstemp(".py")
399 except ImportError:
400 from tempfile import mktemp
401 (script_fd, script_name) = None, mktemp(".py")
402 log.info("writing byte-compilation script '%s'", script_name)
403 if not dry_run:
404 if script_fd is not None:
405 script = os.fdopen(script_fd, "w")
406 else:
407 script = open(script_name, "w")
408
409 script.write("""\
410from distutils.util import byte_compile
411files = [
412""")
413
414 # XXX would be nice to write absolute filenames, just for
415 # safety's sake (script should be more robust in the face of
416 # chdir'ing before running it). But this requires abspath'ing
417 # 'prefix' as well, and that breaks the hack in build_lib's
418 # 'byte_compile()' method that carefully tacks on a trailing
419 # slash (os.sep really) to make sure the prefix here is "just
420 # right". This whole prefix business is rather delicate -- the
421 # problem is that it's really a directory, but I'm treating it
422 # as a dumb string, so trailing slashes and so forth matter.
423
424 #py_files = map(os.path.abspath, py_files)
425 #if prefix:
426 # prefix = os.path.abspath(prefix)
427
428 script.write(string.join(map(repr, py_files), ",\n") + "]\n")
429 script.write("""
430byte_compile(files, optimize=%r, force=%r,
431 prefix=%r, base_dir=%r,
432 verbose=%r, dry_run=0,
433 direct=1)
434""" % (optimize, force, prefix, base_dir, verbose))
435
436 script.close()
437
438 cmd = [sys.executable, script_name]
439 if optimize == 1:
440 cmd.insert(1, "-O")
441 elif optimize == 2:
442 cmd.insert(1, "-OO")
443 spawn(cmd, dry_run=dry_run)
444 execute(os.remove, (script_name,), "removing %s" % script_name,
445 dry_run=dry_run)
446
447 # "Direct" byte-compilation: use the py_compile module to compile
448 # right here, right now. Note that the script generated in indirect
449 # mode simply calls 'byte_compile()' in direct mode, a weird sort of
450 # cross-process recursion. Hey, it works!
451 else:
452 from py_compile import compile
453
454 for file in py_files:
455 if file[-3:] != ".py":
456 # This lets us be lazy and not filter filenames in
457 # the "install_lib" command.
458 continue
459
460 # Terminology from the py_compile module:
461 # cfile - byte-compiled file
462 # dfile - purported source filename (same as 'file' by default)
463 cfile = file + (__debug__ and "c" or "o")
464 dfile = file
465 if prefix:
466 if file[:len(prefix)] != prefix:
467 raise ValueError, \
468 ("invalid prefix: filename %r doesn't start with %r"
469 % (file, prefix))
470 dfile = dfile[len(prefix):]
471 if base_dir:
472 dfile = os.path.join(base_dir, dfile)
473
474 cfile_base = os.path.basename(cfile)
475 if direct:
476 if force or newer(file, cfile):
477 log.info("byte-compiling %s to %s", file, cfile_base)
478 if not dry_run:
479 compile(file, cfile, dfile)
480 else:
481 log.debug("skipping byte-compilation of %s to %s",
482 file, cfile_base)
483
484# byte_compile ()
485
486def rfc822_escape (header):
487 """Return a version of the string escaped for inclusion in an
488 RFC-822 header, by ensuring there are 8 spaces space after each newline.
489 """
490 lines = string.split(header, '\n')
491 header = string.join(lines, '\n' + 8*' ')
492 return header
Note: See TracBrowser for help on using the repository browser.