0001 """distutils.command.install 0002 0003 Implements the Distutils 'install' command.""" 0004 0005 from distutils import log 0006 0007 # This module should be kept compatible with Python 1.5.2. 0008 0009 __revision__ = "$Id: install.py,v 1.71 2004/10/13 12:35:28 anthonybaxter Exp $" 0010 0011 import sys, os, string 0012 from types import * 0013 from distutils.core import Command 0014 from distutils.debug import DEBUG 0015 from distutils.sysconfig import get_config_vars 0016 from distutils.errors import DistutilsPlatformError 0017 from distutils.file_util import write_file 0018 from distutils.util import convert_path, subst_vars, change_root 0019 from distutils.errors import DistutilsOptionError 0020 from glob import glob 0021 0022 if sys.version < "2.2": 0023 WINDOWS_SCHEME = { 0024 'purelib': '$base', 0025 'platlib': '$base', 0026 'headers': '$base/Include/$dist_name', 0027 'scripts': '$base/Scripts', 0028 'data' : '$base', 0029 } 0030 else: 0031 WINDOWS_SCHEME = { 0032 'purelib': '$base/Lib/site-packages', 0033 'platlib': '$base/Lib/site-packages', 0034 'headers': '$base/Include/$dist_name', 0035 'scripts': '$base/Scripts', 0036 'data' : '$base', 0037 } 0038 0039 INSTALL_SCHEMES = { 0040 'unix_prefix': { 0041 'purelib': '$base/lib/python$py_version_short/site-packages', 0042 'platlib': '$platbase/lib/python$py_version_short/site-packages', 0043 'headers': '$base/include/python$py_version_short/$dist_name', 0044 'scripts': '$base/bin', 0045 'data' : '$base', 0046 }, 0047 'unix_home': { 0048 'purelib': '$base/lib/python', 0049 'platlib': '$base/lib/python', 0050 'headers': '$base/include/python/$dist_name', 0051 'scripts': '$base/bin', 0052 'data' : '$base', 0053 }, 0054 'nt': WINDOWS_SCHEME, 0055 'mac': { 0056 'purelib': '$base/Lib/site-packages', 0057 'platlib': '$base/Lib/site-packages', 0058 'headers': '$base/Include/$dist_name', 0059 'scripts': '$base/Scripts', 0060 'data' : '$base', 0061 }, 0062 'os2': { 0063 'purelib': '$base/Lib/site-packages', 0064 'platlib': '$base/Lib/site-packages', 0065 'headers': '$base/Include/$dist_name', 0066 'scripts': '$base/Scripts', 0067 'data' : '$base', 0068 } 0069 } 0070 0071 # The keys to an installation scheme; if any new types of files are to be 0072 # installed, be sure to add an entry to every installation scheme above, 0073 # and to SCHEME_KEYS here. 0074 SCHEME_KEYS = ('purelib', 'platlib', 'headers', 'scripts', 'data') 0075 0076 0077 class install (Command): 0078 0079 description = "install everything from build directory" 0080 0081 user_options = [ 0082 # Select installation scheme and set base director(y|ies) 0083 ('prefix=', None, 0084 "installation prefix"), 0085 ('exec-prefix=', None, 0086 "(Unix only) prefix for platform-specific files"), 0087 ('home=', None, 0088 "(Unix only) home directory to install under"), 0089 0090 # Or, just set the base director(y|ies) 0091 ('install-base=', None, 0092 "base installation directory (instead of --prefix or --home)"), 0093 ('install-platbase=', None, 0094 "base installation directory for platform-specific files " + 0095 "(instead of --exec-prefix or --home)"), 0096 ('root=', None, 0097 "install everything relative to this alternate root directory"), 0098 0099 # Or, explicitly set the installation scheme 0100 ('install-purelib=', None, 0101 "installation directory for pure Python module distributions"), 0102 ('install-platlib=', None, 0103 "installation directory for non-pure module distributions"), 0104 ('install-lib=', None, 0105 "installation directory for all module distributions " + 0106 "(overrides --install-purelib and --install-platlib)"), 0107 0108 ('install-headers=', None, 0109 "installation directory for C/C++ headers"), 0110 ('install-scripts=', None, 0111 "installation directory for Python scripts"), 0112 ('install-data=', None, 0113 "installation directory for data files"), 0114 0115 # Byte-compilation options -- see install_lib.py for details, as 0116 # these are duplicated from there (but only install_lib does 0117 # anything with them). 0118 ('compile', 'c', "compile .py to .pyc [default]"), 0119 ('no-compile', None, "don't compile .py files"), 0120 ('optimize=', 'O', 0121 "also compile with optimization: -O1 for \"python -O\", " 0122 "-O2 for \"python -OO\", and -O0 to disable [default: -O0]"), 0123 0124 # Miscellaneous control options 0125 ('force', 'f', 0126 "force installation (overwrite any existing files)"), 0127 ('skip-build', None, 0128 "skip rebuilding everything (for testing/debugging)"), 0129 0130 # Where to install documentation (eventually!) 0131 #('doc-format=', None, "format of documentation to generate"), 0132 #('install-man=', None, "directory for Unix man pages"), 0133 #('install-html=', None, "directory for HTML documentation"), 0134 #('install-info=', None, "directory for GNU info files"), 0135 0136 ('record=', None, 0137 "filename in which to record list of installed files"), 0138 ] 0139 0140 boolean_options = ['compile', 'force', 'skip-build'] 0141 negative_opt = {'no-compile' : 'compile'} 0142 0143 0144 def initialize_options (self): 0145 0146 # High-level options: these select both an installation base 0147 # and scheme. 0148 self.prefix = None 0149 self.exec_prefix = None 0150 self.home = None 0151 0152 # These select only the installation base; it's up to the user to 0153 # specify the installation scheme (currently, that means supplying 0154 # the --install-{platlib,purelib,scripts,data} options). 0155 self.install_base = None 0156 self.install_platbase = None 0157 self.root = None 0158 0159 # These options are the actual installation directories; if not 0160 # supplied by the user, they are filled in using the installation 0161 # scheme implied by prefix/exec-prefix/home and the contents of 0162 # that installation scheme. 0163 self.install_purelib = None # for pure module distributions 0164 self.install_platlib = None # non-pure (dists w/ extensions) 0165 self.install_headers = None # for C/C++ headers 0166 self.install_lib = None # set to either purelib or platlib 0167 self.install_scripts = None 0168 self.install_data = None 0169 0170 self.compile = None 0171 self.optimize = None 0172 0173 # These two are for putting non-packagized distributions into their 0174 # own directory and creating a .pth file if it makes sense. 0175 # 'extra_path' comes from the setup file; 'install_path_file' can 0176 # be turned off if it makes no sense to install a .pth file. (But 0177 # better to install it uselessly than to guess wrong and not 0178 # install it when it's necessary and would be used!) Currently, 0179 # 'install_path_file' is always true unless some outsider meddles 0180 # with it. 0181 self.extra_path = None 0182 self.install_path_file = 1 0183 0184 # 'force' forces installation, even if target files are not 0185 # out-of-date. 'skip_build' skips running the "build" command, 0186 # handy if you know it's not necessary. 'warn_dir' (which is *not* 0187 # a user option, it's just there so the bdist_* commands can turn 0188 # it off) determines whether we warn about installing to a 0189 # directory not in sys.path. 0190 self.force = 0 0191 self.skip_build = 0 0192 self.warn_dir = 1 0193 0194 # These are only here as a conduit from the 'build' command to the 0195 # 'install_*' commands that do the real work. ('build_base' isn't 0196 # actually used anywhere, but it might be useful in future.) They 0197 # are not user options, because if the user told the install 0198 # command where the build directory is, that wouldn't affect the 0199 # build command. 0200 self.build_base = None 0201 self.build_lib = None 0202 0203 # Not defined yet because we don't know anything about 0204 # documentation yet. 0205 #self.install_man = None 0206 #self.install_html = None 0207 #self.install_info = None 0208 0209 self.record = None 0210 0211 0212 # -- Option finalizing methods ------------------------------------- 0213 # (This is rather more involved than for most commands, 0214 # because this is where the policy for installing third- 0215 # party Python modules on various platforms given a wide 0216 # array of user input is decided. Yes, it's quite complex!) 0217 0218 def finalize_options (self): 0219 0220 # This method (and its pliant slaves, like 'finalize_unix()', 0221 # 'finalize_other()', and 'select_scheme()') is where the default 0222 # installation directories for modules, extension modules, and 0223 # anything else we care to install from a Python module 0224 # distribution. Thus, this code makes a pretty important policy 0225 # statement about how third-party stuff is added to a Python 0226 # installation! Note that the actual work of installation is done 0227 # by the relatively simple 'install_*' commands; they just take 0228 # their orders from the installation directory options determined 0229 # here. 0230 0231 # Check for errors/inconsistencies in the options; first, stuff 0232 # that's wrong on any platform. 0233 0234 if ((self.prefix or self.exec_prefix or self.home) and 0235 (self.install_base or self.install_platbase)): 0236 raise DistutilsOptionError, \ 0237 ("must supply either prefix/exec-prefix/home or " + 0238 "install-base/install-platbase -- not both") 0239 0240 if self.home and (self.prefix or self.exec_prefix): 0241 raise DistutilsOptionError, \ 0242 "must supply either home or prefix/exec-prefix -- not both" 0243 0244 # Next, stuff that's wrong (or dubious) only on certain platforms. 0245 if os.name != "posix": 0246 if self.exec_prefix: 0247 self.warn("exec-prefix option ignored on this platform") 0248 self.exec_prefix = None 0249 0250 # Now the interesting logic -- so interesting that we farm it out 0251 # to other methods. The goal of these methods is to set the final 0252 # values for the install_{lib,scripts,data,...} options, using as 0253 # input a heady brew of prefix, exec_prefix, home, install_base, 0254 # install_platbase, user-supplied versions of 0255 # install_{purelib,platlib,lib,scripts,data,...}, and the 0256 # INSTALL_SCHEME dictionary above. Phew! 0257 0258 self.dump_dirs("pre-finalize_{unix,other}") 0259 0260 if os.name == 'posix': 0261 self.finalize_unix() 0262 else: 0263 self.finalize_other() 0264 0265 self.dump_dirs("post-finalize_{unix,other}()") 0266 0267 # Expand configuration variables, tilde, etc. in self.install_base 0268 # and self.install_platbase -- that way, we can use $base or 0269 # $platbase in the other installation directories and not worry 0270 # about needing recursive variable expansion (shudder). 0271 0272 py_version = (string.split(sys.version))[0] 0273 (prefix, exec_prefix) = get_config_vars('prefix', 'exec_prefix') 0274 self.config_vars = {'dist_name': self.distribution.get_name(), 0275 'dist_version': self.distribution.get_version(), 0276 'dist_fullname': self.distribution.get_fullname(), 0277 'py_version': py_version, 0278 'py_version_short': py_version[0:3], 0279 'sys_prefix': prefix, 0280 'prefix': prefix, 0281 'sys_exec_prefix': exec_prefix, 0282 'exec_prefix': exec_prefix, 0283 } 0284 self.expand_basedirs() 0285 0286 self.dump_dirs("post-expand_basedirs()") 0287 0288 # Now define config vars for the base directories so we can expand 0289 # everything else. 0290 self.config_vars['base'] = self.install_base 0291 self.config_vars['platbase'] = self.install_platbase 0292 0293 if DEBUG: 0294 from pprint import pprint 0295 print "config vars:" 0296 pprint(self.config_vars) 0297 0298 # Expand "~" and configuration variables in the installation 0299 # directories. 0300 self.expand_dirs() 0301 0302 self.dump_dirs("post-expand_dirs()") 0303 0304 # Pick the actual directory to install all modules to: either 0305 # install_purelib or install_platlib, depending on whether this 0306 # module distribution is pure or not. Of course, if the user 0307 # already specified install_lib, use their selection. 0308 if self.install_lib is None: 0309 if self.distribution.ext_modules: # has extensions: non-pure 0310 self.install_lib = self.install_platlib 0311 else: 0312 self.install_lib = self.install_purelib 0313 0314 0315 # Convert directories from Unix /-separated syntax to the local 0316 # convention. 0317 self.convert_paths('lib', 'purelib', 'platlib', 0318 'scripts', 'data', 'headers') 0319 0320 # Well, we're not actually fully completely finalized yet: we still 0321 # have to deal with 'extra_path', which is the hack for allowing 0322 # non-packagized module distributions (hello, Numerical Python!) to 0323 # get their own directories. 0324 self.handle_extra_path() 0325 self.install_libbase = self.install_lib # needed for .pth file 0326 self.install_lib = os.path.join(self.install_lib, self.extra_dirs) 0327 0328 # If a new root directory was supplied, make all the installation 0329 # dirs relative to it. 0330 if self.root is not None: 0331 self.change_roots('libbase', 'lib', 'purelib', 'platlib', 0332 'scripts', 'data', 'headers') 0333 0334 self.dump_dirs("after prepending root") 0335 0336 # Find out the build directories, ie. where to install from. 0337 self.set_undefined_options('build', 0338 ('build_base', 'build_base'), 0339 ('build_lib', 'build_lib')) 0340 0341 # Punt on doc directories for now -- after all, we're punting on 0342 # documentation completely! 0343 0344 # finalize_options () 0345 0346 0347 def dump_dirs (self, msg): 0348 if DEBUG: 0349 from distutils.fancy_getopt import longopt_xlate 0350 print msg + ":" 0351 for opt in self.user_options: 0352 opt_name = opt[0] 0353 if opt_name[-1] == "=": 0354 opt_name = opt_name[0:-1] 0355 opt_name = string.translate(opt_name, longopt_xlate) 0356 val = getattr(self, opt_name) 0357 print " %s: %s" % (opt_name, val) 0358 0359 0360 def finalize_unix (self): 0361 0362 if self.install_base is not None or self.install_platbase is not None: 0363 if ((self.install_lib is None and 0364 self.install_purelib is None and 0365 self.install_platlib is None) or 0366 self.install_headers is None or 0367 self.install_scripts is None or 0368 self.install_data is None): 0369 raise DistutilsOptionError, \ 0370 ("install-base or install-platbase supplied, but " 0371 "installation scheme is incomplete") 0372 return 0373 0374 if self.home is not None: 0375 self.install_base = self.install_platbase = self.home 0376 self.select_scheme("unix_home") 0377 else: 0378 if self.prefix is None: 0379 if self.exec_prefix is not None: 0380 raise DistutilsOptionError, \ 0381 "must not supply exec-prefix without prefix" 0382 0383 self.prefix = os.path.normpath(sys.prefix) 0384 self.exec_prefix = os.path.normpath(sys.exec_prefix) 0385 0386 else: 0387 if self.exec_prefix is None: 0388 self.exec_prefix = self.prefix 0389 0390 self.install_base = self.prefix 0391 self.install_platbase = self.exec_prefix 0392 self.select_scheme("unix_prefix") 0393 0394 # finalize_unix () 0395 0396 0397 def finalize_other (self): # Windows and Mac OS for now 0398 0399 if self.home is not None: 0400 self.install_base = self.install_platbase = self.home 0401 self.select_scheme("unix_home") 0402 else: 0403 if self.prefix is None: 0404 self.prefix = os.path.normpath(sys.prefix) 0405 0406 self.install_base = self.install_platbase = self.prefix 0407 try: 0408 self.select_scheme(os.name) 0409 except KeyError: 0410 raise DistutilsPlatformError, \ 0411 "I don't know how to install stuff on '%s'" % os.name 0412 0413 # finalize_other () 0414 0415 0416 def select_scheme (self, name): 0417 # it's the caller's problem if they supply a bad name! 0418 scheme = INSTALL_SCHEMES[name] 0419 for key in SCHEME_KEYS: 0420 attrname = 'install_' + key 0421 if getattr(self, attrname) is None: 0422 setattr(self, attrname, scheme[key]) 0423 0424 0425 def _expand_attrs (self, attrs): 0426 for attr in attrs: 0427 val = getattr(self, attr) 0428 if val is not None: 0429 if os.name == 'posix': 0430 val = os.path.expanduser(val) 0431 val = subst_vars(val, self.config_vars) 0432 setattr(self, attr, val) 0433 0434 0435 def expand_basedirs (self): 0436 self._expand_attrs(['install_base', 0437 'install_platbase', 0438 'root']) 0439 0440 def expand_dirs (self): 0441 self._expand_attrs(['install_purelib', 0442 'install_platlib', 0443 'install_lib', 0444 'install_headers', 0445 'install_scripts', 0446 'install_data',]) 0447 0448 0449 def convert_paths (self, *names): 0450 for name in names: 0451 attr = "install_" + name 0452 setattr(self, attr, convert_path(getattr(self, attr))) 0453 0454 0455 def handle_extra_path (self): 0456 0457 if self.extra_path is None: 0458 self.extra_path = self.distribution.extra_path 0459 0460 if self.extra_path is not None: 0461 if type(self.extra_path) is StringType: 0462 self.extra_path = string.split(self.extra_path, ',') 0463 0464 if len(self.extra_path) == 1: 0465 path_file = extra_dirs = self.extra_path[0] 0466 elif len(self.extra_path) == 2: 0467 (path_file, extra_dirs) = self.extra_path 0468 else: 0469 raise DistutilsOptionError, \ 0470 ("'extra_path' option must be a list, tuple, or " 0471 "comma-separated string with 1 or 2 elements") 0472 0473 # convert to local form in case Unix notation used (as it 0474 # should be in setup scripts) 0475 extra_dirs = convert_path(extra_dirs) 0476 0477 else: 0478 path_file = None 0479 extra_dirs = '' 0480 0481 # XXX should we warn if path_file and not extra_dirs? (in which 0482 # case the path file would be harmless but pointless) 0483 self.path_file = path_file 0484 self.extra_dirs = extra_dirs 0485 0486 # handle_extra_path () 0487 0488 0489 def change_roots (self, *names): 0490 for name in names: 0491 attr = "install_" + name 0492 setattr(self, attr, change_root(self.root, getattr(self, attr))) 0493 0494 0495 # -- Command execution methods ------------------------------------- 0496 0497 def run (self): 0498 0499 # Obviously have to build before we can install 0500 if not self.skip_build: 0501 self.run_command('build') 0502 0503 # Run all sub-commands (at least those that need to be run) 0504 for cmd_name in self.get_sub_commands(): 0505 self.run_command(cmd_name) 0506 0507 if self.path_file: 0508 self.create_path_file() 0509 0510 # write list of installed files, if requested. 0511 if self.record: 0512 outputs = self.get_outputs() 0513 if self.root: # strip any package prefix 0514 root_len = len(self.root) 0515 for counter in xrange(len(outputs)): 0516 outputs[counter] = outputs[counter][root_len:] 0517 self.execute(write_file, 0518 (self.record, outputs), 0519 "writing list of installed files to '%s'" % 0520 self.record) 0521 0522 sys_path = map(os.path.normpath, sys.path) 0523 sys_path = map(os.path.normcase, sys_path) 0524 install_lib = os.path.normcase(os.path.normpath(self.install_lib)) 0525 if (self.warn_dir and 0526 not (self.path_file and self.install_path_file) and 0527 install_lib not in sys_path): 0528 log.debug(("modules installed to '%s', which is not in " 0529 "Python's module search path (sys.path) -- " 0530 "you'll have to change the search path yourself"), 0531 self.install_lib) 0532 0533 # run () 0534 0535 def create_path_file (self): 0536 filename = os.path.join(self.install_libbase, 0537 self.path_file + ".pth") 0538 if self.install_path_file: 0539 self.execute(write_file, 0540 (filename, [self.extra_dirs]), 0541 "creating %s" % filename) 0542 else: 0543 self.warn("path file '%s' not created" % filename) 0544 0545 0546 # -- Reporting methods --------------------------------------------- 0547 0548 def get_outputs (self): 0549 # Assemble the outputs of all the sub-commands. 0550 outputs = [] 0551 for cmd_name in self.get_sub_commands(): 0552 cmd = self.get_finalized_command(cmd_name) 0553 # Add the contents of cmd.get_outputs(), ensuring 0554 # that outputs doesn't contain duplicate entries 0555 for filename in cmd.get_outputs(): 0556 if filename not in outputs: 0557 outputs.append(filename) 0558 0559 if self.path_file and self.install_path_file: 0560 outputs.append(os.path.join(self.install_libbase, 0561 self.path_file + ".pth")) 0562 0563 return outputs 0564 0565 def get_inputs (self): 0566 # XXX gee, this looks familiar ;-( 0567 inputs = [] 0568 for cmd_name in self.get_sub_commands(): 0569 cmd = self.get_finalized_command(cmd_name) 0570 inputs.extend(cmd.get_inputs()) 0571 0572 return inputs 0573 0574 0575 # -- Predicates for sub-command list ------------------------------- 0576 0577 def has_lib (self): 0578 """Return true if the current distribution has any Python 0579 modules to install.""" 0580 return (self.distribution.has_pure_modules() or 0581 self.distribution.has_ext_modules()) 0582 0583 def has_headers (self): 0584 return self.distribution.has_headers() 0585 0586 def has_scripts (self): 0587 return self.distribution.has_scripts() 0588 0589 def has_data (self): 0590 return self.distribution.has_data_files() 0591 0592 0593 # 'sub_commands': a list of commands this command might have to run to 0594 # get its work done. See cmd.py for more info. 0595 sub_commands = [('install_lib', has_lib), 0596 ('install_headers', has_headers), 0597 ('install_scripts', has_scripts), 0598 ('install_data', has_data), 0599 ] 0600 0601 # class install 0602
Generated by PyXR 0.9.4