Lib/distutils/command/install.py

   1 """distutils.command.install
   2
   3 Implements the Distutils 'install' command."""
   4
   5 # created 1999/03/13, Greg Ward
   6
   7 __revision__ = "$Id$"
   8
   9 import sys, os, string
  10 from types import *
  11 from distutils.core import Command, DEBUG
  12 from distutils.sysconfig import get_config_vars
  13 from distutils.errors import DistutilsPlatformError
  14 from distutils.file_util import write_file
  15 from distutils.util import convert_path, subst_vars, change_root
  16 from distutils.errors import DistutilsOptionError
  17 from glob import glob
  18
  19 INSTALL_SCHEMES = {
  20     'unix_prefix': {
  21         'purelib': '$base/lib/python$py_version_short/site-packages',
  22         'platlib': '$platbase/lib/python$py_version_short/site-packages',
  23         'headers': '$base/include/python$py_version_short/$dist_name',
  24         'scripts': '$base/bin',
  25         'data'   : '$base',
  26         },
  27     'unix_home': {
  28         'purelib': '$base/lib/python',
  29         'platlib': '$base/lib/python',
  30         'headers': '$base/include/python/$dist_name',
  31         'scripts': '$base/bin',
  32         'data'   : '$base',
  33         },
  34     'nt': {
  35         'purelib': '$base',
  36         'platlib': '$base',
  37         'headers': '$base/Include/$dist_name',
  38         'scripts': '$base/Scripts',
  39         'data'   : '$base',
  40         },
  41     'mac': {
  42         'purelib': '$base/Lib/site-packages',
  43         'platlib': '$base/Lib/site-packages',
  44         'headers': '$base/Include/$dist_name',
  45         'scripts': '$base/Scripts',
  46         'data'   : '$base',
  47         }
  48     }
  49
  50 # The keys to an installation scheme; if any new types of files are to be
  51 # installed, be sure to add an entry to every installation scheme above,
  52 # and to SCHEME_KEYS here.
  53 SCHEME_KEYS = ('purelib', 'platlib', 'headers', 'scripts', 'data')
  54
  55
  56 class install (Command):
  57
  58     description = "install everything from build directory"
  59
  60     user_options = [
  61         # Select installation scheme and set base director(y|ies)
  62         ('prefix=', None,
  63          "installation prefix"),
  64         ('exec-prefix=', None,
  65          "(Unix only) prefix for platform-specific files"),
  66         ('home=', None,
  67          "(Unix only) home directory to install under"),
  68
  69         # Or, just set the base director(y|ies)
  70         ('install-base=', None,
  71          "base installation directory (instead of --prefix or --home)"),
  72         ('install-platbase=', None,
  73          "base installation directory for platform-specific files " +
  74          "(instead of --exec-prefix or --home)"),
  75         ('root=', None,
  76          "install everything relative to this alternate root directory"),
  77
  78         # Or, explicitly set the installation scheme
  79         ('install-purelib=', None,
  80          "installation directory for pure Python module distributions"),
  81         ('install-platlib=', None,
  82          "installation directory for non-pure module distributions"),
  83         ('install-lib=', None,
  84          "installation directory for all module distributions " +
  85          "(overrides --install-purelib and --install-platlib)"),
  86
  87         ('install-headers=', None,
  88          "installation directory for C/C++ headers"),
  89         ('install-scripts=', None,
  90          "installation directory for Python scripts"),
  91         ('install-data=', None,
  92          "installation directory for data files"),
  93
  94         # Byte-compilation options -- see install_lib.py for details, as
  95         # these are duplicated from there (but only install_lib does
  96         # anything with them).
  97         ('compile', 'c', "compile .py to .pyc [default]"),
  98         ('no-compile', None, "don't compile .py files"),
  99         ('optimize=', 'O',
 100          "also compile with optimization: -O1 for \"python -O\", "
 101          "-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),
 102
 103         # Miscellaneous control options
 104         ('force', 'f',
 105          "force installation (overwrite any existing files)"),
 106         ('skip-build', None,
 107          "skip rebuilding everything (for testing/debugging)"),
 108
 109         # Where to install documentation (eventually!)
 110         #('doc-format=', None, "format of documentation to generate"),
 111         #('install-man=', None, "directory for Unix man pages"),
 112         #('install-html=', None, "directory for HTML documentation"),
 113         #('install-info=', None, "directory for GNU info files"),
 114
 115         ('record=', None,
 116          "filename in which to record list of installed files"),
 117         ]
 118
 119     boolean_options = ['force', 'skip-build']
 120     negative_opt = {'no-compile' : 'compile'}
 121
 122
 123     def initialize_options (self):
 124
 125         # High-level options: these select both an installation base
 126         # and scheme.
 127         self.prefix = None
 128         self.exec_prefix = None
 129         self.home = None
 130
 131         # These select only the installation base; it's up to the user to
 132         # specify the installation scheme (currently, that means supplying
 133         # the --install-{platlib,purelib,scripts,data} options).
 134         self.install_base = None
 135         self.install_platbase = None
 136         self.root = None
 137
 138         # These options are the actual installation directories; if not
 139         # supplied by the user, they are filled in using the installation
 140         # scheme implied by prefix/exec-prefix/home and the contents of
 141         # that installation scheme.
 142         self.install_purelib = None     # for pure module distributions
 143         self.install_platlib = None     # non-pure (dists w/ extensions)
 144         self.install_headers = None     # for C/C++ headers
 145         self.install_lib = None         # set to either purelib or platlib
 146         self.install_scripts = None
 147         self.install_data = None
 148
 149         self.compile = None
 150         self.no_compile = None
 151         self.optimize = None
 152
 153         # These two are for putting non-packagized distributions into their
 154         # own directory and creating a .pth file if it makes sense.
 155         # 'extra_path' comes from the setup file; 'install_path_file' can
 156         # be turned off if it makes no sense to install a .pth file.  (But
 157         # better to install it uselessly than to guess wrong and not
 158         # install it when it's necessary and would be used!)  Currently,
 159         # 'install_path_file' is always true unless some outsider meddles
 160         # with it.
 161         self.extra_path = None
 162         self.install_path_file = 1
 163
 164         # 'force' forces installation, even if target files are not
 165         # out-of-date.  'skip_build' skips running the "build" command,
 166         # handy if you know it's not necessary.  'warn_dir' (which is *not*
 167         # a user option, it's just there so the bdist_* commands can turn
 168         # it off) determines whether we warn about installing to a
 169         # directory not in sys.path.
 170         self.force = 0
 171         self.skip_build = 0
 172         self.warn_dir = 1
 173
 174         # These are only here as a conduit from the 'build' command to the
 175         # 'install_*' commands that do the real work.  ('build_base' isn't
 176         # actually used anywhere, but it might be useful in future.)  They
 177         # are not user options, because if the user told the install
 178         # command where the build directory is, that wouldn't affect the
 179         # build command.
 180         self.build_base = None
 181         self.build_lib = None
 182
 183         # Not defined yet because we don't know anything about
 184         # documentation yet.
 185         #self.install_man = None
 186         #self.install_html = None
 187         #self.install_info = None
 188
 189         self.record = None
 190
 191
 192     # -- Option finalizing methods -------------------------------------
 193     # (This is rather more involved than for most commands,
 194     # because this is where the policy for installing third-
 195     # party Python modules on various platforms given a wide
 196     # array of user input is decided.  Yes, it's quite complex!)
 197
 198     def finalize_options (self):
 199
 200         # This method (and its pliant slaves, like 'finalize_unix()',
 201         # 'finalize_other()', and 'select_scheme()') is where the default
 202         # installation directories for modules, extension modules, and
 203         # anything else we care to install from a Python module
 204         # distribution.  Thus, this code makes a pretty important policy
 205         # statement about how third-party stuff is added to a Python
 206         # installation!  Note that the actual work of installation is done
 207         # by the relatively simple 'install_*' commands; they just take
 208         # their orders from the installation directory options determined
 209         # here.
 210
 211         # Check for errors/inconsistencies in the options; first, stuff
 212         # that's wrong on any platform.
 213
 214         if ((self.prefix or self.exec_prefix or self.home) and
 215             (self.install_base or self.install_platbase)):
 216             raise DistutilsOptionError, \
 217                   ("must supply either prefix/exec-prefix/home or " +
 218                    "install-base/install-platbase -- not both")
 219
 220         # Next, stuff that's wrong (or dubious) only on certain platforms.
 221         if os.name == 'posix':
 222             if self.home and (self.prefix or self.exec_prefix):
 223                 raise DistutilsOptionError, \
 224                       ("must supply either home or prefix/exec-prefix -- " +
 225                        "not both")
 226         else:
 227             if self.exec_prefix:
 228                 self.warn("exec-prefix option ignored on this platform")
 229                 self.exec_prefix = None
 230             if self.home:
 231                 self.warn("home option ignored on this platform")
 232                 self.home = None
 233
 234         # Now the interesting logic -- so interesting that we farm it out
 235         # to other methods.  The goal of these methods is to set the final
 236         # values for the install_{lib,scripts,data,...}  options, using as
 237         # input a heady brew of prefix, exec_prefix, home, install_base,
 238         # install_platbase, user-supplied versions of
 239         # install_{purelib,platlib,lib,scripts,data,...}, and the
 240         # INSTALL_SCHEME dictionary above.  Phew!
 241
 242         self.dump_dirs("pre-finalize_{unix,other}")
 243
 244         if os.name == 'posix':
 245             self.finalize_unix()
 246         else:
 247             self.finalize_other()
 248
 249         self.dump_dirs("post-finalize_{unix,other}()")
 250
 251         # Expand configuration variables, tilde, etc. in self.install_base
 252         # and self.install_platbase -- that way, we can use $base or
 253         # $platbase in the other installation directories and not worry
 254         # about needing recursive variable expansion (shudder).
 255
 256         py_version = (string.split(sys.version))[0]
 257         (prefix, exec_prefix) = get_config_vars('prefix', 'exec_prefix')
 258         self.config_vars = {'dist_name': self.distribution.get_name(),
 259                             'dist_version': self.distribution.get_version(),
 260                             'dist_fullname': self.distribution.get_fullname(),
 261                             'py_version': py_version,
 262                             'py_version_short': py_version[0:3],
 263                             'sys_prefix': prefix,
 264                             'prefix': prefix,
 265                             'sys_exec_prefix': exec_prefix,
 266                             'exec_prefix': exec_prefix,
 267                            }
 268         self.expand_basedirs()
 269
 270         self.dump_dirs("post-expand_basedirs()")
 271
 272         # Now define config vars for the base directories so we can expand
 273         # everything else.
 274         self.config_vars['base'] = self.install_base
 275         self.config_vars['platbase'] = self.install_platbase
 276
 277         if DEBUG:
 278             from pprint import pprint
 279             print "config vars:"
 280             pprint(self.config_vars)
 281
 282         # Expand "~" and configuration variables in the installation
 283         # directories.
 284         self.expand_dirs()
 285
 286         self.dump_dirs("post-expand_dirs()")
 287
 288         # Pick the actual directory to install all modules to: either
 289         # install_purelib or install_platlib, depending on whether this
 290         # module distribution is pure or not.  Of course, if the user
 291         # already specified install_lib, use their selection.
 292         if self.install_lib is None:
 293             if self.distribution.ext_modules: # has extensions: non-pure
 294                 self.install_lib = self.install_platlib
 295             else:
 296                 self.install_lib = self.install_purelib
 297
 298
 299         # Convert directories from Unix /-separated syntax to the local
 300         # convention.
 301         self.convert_paths('lib', 'purelib', 'platlib',
 302                            'scripts', 'data', 'headers')
 303
 304         # Well, we're not actually fully completely finalized yet: we still
 305         # have to deal with 'extra_path', which is the hack for allowing
 306         # non-packagized module distributions (hello, Numerical Python!) to
 307         # get their own directories.
 308         self.handle_extra_path()
 309         self.install_libbase = self.install_lib # needed for .pth file
 310         self.install_lib = os.path.join(self.install_lib, self.extra_dirs)
 311
 312         # If a new root directory was supplied, make all the installation
 313         # dirs relative to it.
 314         if self.root is not None:
 315             self.change_roots('libbase', 'lib', 'purelib', 'platlib',
 316                               'scripts', 'data', 'headers')
 317
 318         self.dump_dirs("after prepending root")
 319
 320         # Find out the build directories, ie. where to install from.
 321         self.set_undefined_options('build',
 322                                    ('build_base', 'build_base'),
 323                                    ('build_lib', 'build_lib'))
 324
 325         # Punt on doc directories for now -- after all, we're punting on
 326         # documentation completely!
 327
 328     # finalize_options ()
 329
 330
 331     def dump_dirs (self, msg):
 332         if DEBUG:
 333             from distutils.fancy_getopt import longopt_xlate
 334             print msg + ":"
 335             for opt in self.user_options:
 336                 opt_name = opt[0]
 337                 if opt_name[-1] == "=":
 338                     opt_name = opt_name[0:-1]
 339                 opt_name = string.translate(opt_name, longopt_xlate)
 340                 val = getattr(self, opt_name)
 341                 print "  %s: %s" % (opt_name, val)
 342
 343
 344     def finalize_unix (self):
 345
 346         if self.install_base is not None or self.install_platbase is not None:
 347             if ((self.install_lib is None and
 348                  self.install_purelib is None and
 349                  self.install_platlib is None) or
 350                 self.install_headers is None or
 351                 self.install_scripts is None or
 352                 self.install_data is None):
 353                 raise DistutilsOptionError, \
 354                       "install-base or install-platbase supplied, but " + \
 355                       "installation scheme is incomplete"
 356             return
 357
 358         if self.home is not None:
 359             self.install_base = self.install_platbase = self.home
 360             self.select_scheme("unix_home")
 361         else:
 362             if self.prefix is None:
 363                 if self.exec_prefix is not None:
 364                     raise DistutilsOptionError, \
 365                           "must not supply exec-prefix without prefix"
 366
 367                 self.prefix = os.path.normpath(sys.prefix)
 368                 self.exec_prefix = os.path.normpath(sys.exec_prefix)
 369
 370             else:
 371                 if self.exec_prefix is None:
 372                     self.exec_prefix = self.prefix
 373
 374             self.install_base = self.prefix
 375             self.install_platbase = self.exec_prefix
 376             self.select_scheme("unix_prefix")
 377
 378     # finalize_unix ()
 379
 380
 381     def finalize_other (self):          # Windows and Mac OS for now
 382
 383         if self.prefix is None:
 384             self.prefix = os.path.normpath(sys.prefix)
 385
 386         self.install_base = self.install_platbase = self.prefix
 387         try:
 388             self.select_scheme(os.name)
 389         except KeyError:
 390             raise DistutilsPlatformError, \
 391                   "I don't know how to install stuff on '%s'" % os.name
 392
 393     # finalize_other ()
 394
 395
 396     def select_scheme (self, name):
 397         # it's the caller's problem if they supply a bad name!
 398         scheme = INSTALL_SCHEMES[name]
 399         for key in SCHEME_KEYS:
 400             attrname = 'install_' + key
 401             if getattr(self, attrname) is None:
 402                 setattr(self, attrname, scheme[key])
 403
 404
 405     def _expand_attrs (self, attrs):
 406         for attr in attrs:
 407             val = getattr(self, attr)
 408             if val is not None:
 409                 if os.name == 'posix':
 410                     val = os.path.expanduser(val)
 411                 val = subst_vars(val, self.config_vars)
 412                 setattr(self, attr, val)
 413
 414
 415     def expand_basedirs (self):
 416         self._expand_attrs(['install_base',
 417                             'install_platbase',
 418                             'root'])
 419
 420     def expand_dirs (self):
 421         self._expand_attrs(['install_purelib',
 422                             'install_platlib',
 423                             'install_lib',
 424                             'install_headers',
 425                             'install_scripts',
 426                             'install_data',])
 427
 428
 429     def convert_paths (self, *names):
 430         for name in names:
 431             attr = "install_" + name
 432             setattr(self, attr, convert_path(getattr(self, attr)))
 433
 434
 435     def handle_extra_path (self):
 436
 437         if self.extra_path is None:
 438             self.extra_path = self.distribution.extra_path
 439
 440         if self.extra_path is not None:
 441             if type(self.extra_path) is StringType:
 442                 self.extra_path = string.split(self.extra_path, ',')
 443
 444             if len(self.extra_path) == 1:
 445                 path_file = extra_dirs = self.extra_path[0]
 446             elif len(self.extra_path) == 2:
 447                 (path_file, extra_dirs) = self.extra_path
 448             else:
 449                 raise DistutilsOptionError, \
 450                       "'extra_path' option must be a list, tuple, or " + \
 451                       "comma-separated string with 1 or 2 elements"
 452
 453             # convert to local form in case Unix notation used (as it
 454             # should be in setup scripts)
 455             extra_dirs = convert_path(extra_dirs)
 456
 457         else:
 458             path_file = None
 459             extra_dirs = ''
 460
 461         # XXX should we warn if path_file and not extra_dirs? (in which
 462         # case the path file would be harmless but pointless)
 463         self.path_file = path_file
 464         self.extra_dirs = extra_dirs
 465
 466     # handle_extra_path ()
 467
 468
 469     def change_roots (self, *names):
 470         for name in names:
 471             attr = "install_" + name
 472             setattr(self, attr, change_root(self.root, getattr(self, attr)))
 473
 474
 475     # -- Command execution methods -------------------------------------
 476
 477     def run (self):
 478
 479         # Obviously have to build before we can install
 480         if not self.skip_build:
 481             self.run_command('build')
 482
 483         # Run all sub-commands (at least those that need to be run)
 484         for cmd_name in self.get_sub_commands():
 485             self.run_command(cmd_name)
 486
 487         if self.path_file:
 488             self.create_path_file()
 489
 490         # write list of installed files, if requested.
 491         if self.record:
 492             outputs = self.get_outputs()
 493             if self.root:               # strip any package prefix
 494                 root_len = len(self.root)
 495                 for counter in xrange(len(outputs)):
 496                     outputs[counter] = outputs[counter][root_len:]
 497             self.execute(write_file,
 498                          (self.record, outputs),
 499                          "writing list of installed files to '%s'" %
 500                          self.record)
 501
 502         sys_path = map(os.path.normpath, sys.path)
 503         sys_path = map(os.path.normcase, sys_path)
 504         install_lib = os.path.normcase(os.path.normpath(self.install_lib))
 505         if (self.warn_dir and
 506             not (self.path_file and self.install_path_file) and
 507             install_lib not in sys_path):
 508             self.warn(("modules installed to '%s', which is not in " +
 509                        "Python's module search path (sys.path) -- " +
 510                        "you'll have to change the search path yourself") %
 511                       self.install_lib)
 512
 513     # run ()
 514
 515     def create_path_file (self):
 516         filename = os.path.join(self.install_libbase,
 517                                 self.path_file + ".pth")
 518         if self.install_path_file:
 519             self.execute(write_file,
 520                          (filename, [self.extra_dirs]),
 521                          "creating %s" % filename)
 522         else:
 523             self.warn("path file '%s' not created" % filename)
 524
 525
 526     # -- Reporting methods ---------------------------------------------
 527
 528     def get_outputs (self):
 529         # This command doesn't have any outputs of its own, so just
 530         # get the outputs of all its sub-commands.
 531         outputs = []
 532         for cmd_name in self.get_sub_commands():
 533             cmd = self.get_finalized_command(cmd_name)
 534             # Add the contents of cmd.get_outputs(), ensuring
 535             # that outputs doesn't contain duplicate entries
 536             for filename in cmd.get_outputs():
 537                 if filename not in outputs:
 538                     outputs.append(filename)
 539
 540         return outputs
 541
 542     def get_inputs (self):
 543         # XXX gee, this looks familiar ;-(
 544         inputs = []
 545         for cmd_name in self.get_sub_commands():
 546             cmd = self.get_finalized_command(cmd_name)
 547             inputs.extend(cmd.get_inputs())
 548
 549         return inputs
 550
 551
 552     # -- Predicates for sub-command list -------------------------------
 553
 554     def has_lib (self):
 555         """Return true if the current distribution has any Python
 556         modules to install."""
 557         return (self.distribution.has_pure_modules() or
 558                 self.distribution.has_ext_modules())
 559
 560     def has_headers (self):
 561         return self.distribution.has_headers()
 562
 563     def has_scripts (self):
 564         return self.distribution.has_scripts()
 565
 566     def has_data (self):
 567         return self.distribution.has_data_files()
 568
 569
 570     # 'sub_commands': a list of commands this command might have to run to
 571     # get its work done.  See cmd.py for more info.
 572     sub_commands = [('install_lib',     has_lib),
 573                     ('install_headers', has_headers),
 574                     ('install_scripts', has_scripts),
 575                     ('install_data',    has_data),
 576                    ]
 577
 578 # class install