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