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.optimize = None
 150
 151         # These two are for putting non-packagized distributions into their
 152         # own directory and creating a .pth file if it makes sense.
 153         # 'extra_path' comes from the setup file; 'install_path_file' can
 154         # be turned off if it makes no sense to install a .pth file.  (But
 155         # better to install it uselessly than to guess wrong and not
 156         # install it when it's necessary and would be used!)  Currently,
 157         # 'install_path_file' is always true unless some outsider meddles
 158         # with it.
 159         self.extra_path = None
 160         self.install_path_file = 1
 161
 162         # 'force' forces installation, even if target files are not
 163         # out-of-date.  'skip_build' skips running the "build" command,
 164         # handy if you know it's not necessary.  'warn_dir' (which is *not*
 165         # a user option, it's just there so the bdist_* commands can turn
 166         # it off) determines whether we warn about installing to a
 167         # directory not in sys.path.
 168         self.force = 0
 169         self.skip_build = 0
 170         self.warn_dir = 1
 171
 172         # These are only here as a conduit from the 'build' command to the
 173         # 'install_*' commands that do the real work.  ('build_base' isn't
 174         # actually used anywhere, but it might be useful in future.)  They
 175         # are not user options, because if the user told the install
 176         # command where the build directory is, that wouldn't affect the
 177         # build command.
 178         self.build_base = None
 179         self.build_lib = None
 180
 181         # Not defined yet because we don't know anything about
 182         # documentation yet.
 183         #self.install_man = None
 184         #self.install_html = None
 185         #self.install_info = None
 186
 187         self.record = None
 188
 189
 190     # -- Option finalizing methods -------------------------------------
 191     # (This is rather more involved than for most commands,
 192     # because this is where the policy for installing third-
 193     # party Python modules on various platforms given a wide
 194     # array of user input is decided.  Yes, it's quite complex!)
 195
 196     def finalize_options (self):
 197
 198         # This method (and its pliant slaves, like 'finalize_unix()',
 199         # 'finalize_other()', and 'select_scheme()') is where the default
 200         # installation directories for modules, extension modules, and
 201         # anything else we care to install from a Python module
 202         # distribution.  Thus, this code makes a pretty important policy
 203         # statement about how third-party stuff is added to a Python
 204         # installation!  Note that the actual work of installation is done
 205         # by the relatively simple 'install_*' commands; they just take
 206         # their orders from the installation directory options determined
 207         # here.
 208
 209         # Check for errors/inconsistencies in the options; first, stuff
 210         # that's wrong on any platform.
 211
 212         if ((self.prefix or self.exec_prefix or self.home) and
 213             (self.install_base or self.install_platbase)):
 214             raise DistutilsOptionError, \
 215                   ("must supply either prefix/exec-prefix/home or " +
 216                    "install-base/install-platbase -- not both")
 217
 218         # Next, stuff that's wrong (or dubious) only on certain platforms.
 219         if os.name == 'posix':
 220             if self.home and (self.prefix or self.exec_prefix):
 221                 raise DistutilsOptionError, \
 222                       ("must supply either home or prefix/exec-prefix -- " +
 223                        "not both")
 224         else:
 225             if self.exec_prefix:
 226                 self.warn("exec-prefix option ignored on this platform")
 227                 self.exec_prefix = None
 228             if self.home:
 229                 self.warn("home option ignored on this platform")
 230                 self.home = None
 231
 232         # Now the interesting logic -- so interesting that we farm it out
 233         # to other methods.  The goal of these methods is to set the final
 234         # values for the install_{lib,scripts,data,...}  options, using as
 235         # input a heady brew of prefix, exec_prefix, home, install_base,
 236         # install_platbase, user-supplied versions of
 237         # install_{purelib,platlib,lib,scripts,data,...}, and the
 238         # INSTALL_SCHEME dictionary above.  Phew!
 239
 240         self.dump_dirs("pre-finalize_{unix,other}")
 241
 242         if os.name == 'posix':
 243             self.finalize_unix()
 244         else:
 245             self.finalize_other()
 246
 247         self.dump_dirs("post-finalize_{unix,other}()")
 248
 249         # Expand configuration variables, tilde, etc. in self.install_base
 250         # and self.install_platbase -- that way, we can use $base or
 251         # $platbase in the other installation directories and not worry
 252         # about needing recursive variable expansion (shudder).
 253
 254         py_version = (string.split(sys.version))[0]
 255         (prefix, exec_prefix) = get_config_vars('prefix', 'exec_prefix')
 256         self.config_vars = {'dist_name': self.distribution.get_name(),
 257                             'dist_version': self.distribution.get_version(),
 258                             'dist_fullname': self.distribution.get_fullname(),
 259                             'py_version': py_version,
 260                             'py_version_short': py_version[0:3],
 261                             'sys_prefix': prefix,
 262                             'prefix': prefix,
 263                             'sys_exec_prefix': exec_prefix,
 264                             'exec_prefix': exec_prefix,
 265                            }
 266         self.expand_basedirs()
 267
 268         self.dump_dirs("post-expand_basedirs()")
 269
 270         # Now define config vars for the base directories so we can expand
 271         # everything else.
 272         self.config_vars['base'] = self.install_base
 273         self.config_vars['platbase'] = self.install_platbase
 274
 275         if DEBUG:
 276             from pprint import pprint
 277             print "config vars:"
 278             pprint(self.config_vars)
 279
 280         # Expand "~" and configuration variables in the installation
 281         # directories.
 282         self.expand_dirs()
 283
 284         self.dump_dirs("post-expand_dirs()")
 285
 286         # Pick the actual directory to install all modules to: either
 287         # install_purelib or install_platlib, depending on whether this
 288         # module distribution is pure or not.  Of course, if the user
 289         # already specified install_lib, use their selection.
 290         if self.install_lib is None:
 291             if self.distribution.ext_modules: # has extensions: non-pure
 292                 self.install_lib = self.install_platlib
 293             else:
 294                 self.install_lib = self.install_purelib
 295
 296
 297         # Convert directories from Unix /-separated syntax to the local
 298         # convention.
 299         self.convert_paths('lib', 'purelib', 'platlib',
 300                            'scripts', 'data', 'headers')
 301
 302         # Well, we're not actually fully completely finalized yet: we still
 303         # have to deal with 'extra_path', which is the hack for allowing
 304         # non-packagized module distributions (hello, Numerical Python!) to
 305         # get their own directories.
 306         self.handle_extra_path()
 307         self.install_libbase = self.install_lib # needed for .pth file
 308         self.install_lib = os.path.join(self.install_lib, self.extra_dirs)
 309
 310         # If a new root directory was supplied, make all the installation
 311         # dirs relative to it.
 312         if self.root is not None:
 313             self.change_roots('libbase', 'lib', 'purelib', 'platlib',
 314                               'scripts', 'data', 'headers')
 315
 316         self.dump_dirs("after prepending root")
 317
 318         # Find out the build directories, ie. where to install from.
 319         self.set_undefined_options('build',
 320                                    ('build_base', 'build_base'),
 321                                    ('build_lib', 'build_lib'))
 322
 323         # Punt on doc directories for now -- after all, we're punting on
 324         # documentation completely!
 325
 326     # finalize_options ()
 327
 328
 329     def dump_dirs (self, msg):
 330         if DEBUG:
 331             from distutils.fancy_getopt import longopt_xlate
 332             print msg + ":"
 333             for opt in self.user_options:
 334                 opt_name = opt[0]
 335                 if opt_name[-1] == "=":
 336                     opt_name = opt_name[0:-1]
 337                 opt_name = string.translate(opt_name, longopt_xlate)
 338                 val = getattr(self, opt_name)
 339                 print "  %s: %s" % (opt_name, val)
 340
 341
 342     def finalize_unix (self):
 343
 344         if self.install_base is not None or self.install_platbase is not None:
 345             if ((self.install_lib is None and
 346                  self.install_purelib is None and
 347                  self.install_platlib is None) or
 348                 self.install_headers is None or
 349                 self.install_scripts is None or
 350                 self.install_data is None):
 351                 raise DistutilsOptionError, \
 352                       "install-base or install-platbase supplied, but " + \
 353                       "installation scheme is incomplete"
 354             return
 355
 356         if self.home is not None:
 357             self.install_base = self.install_platbase = self.home
 358             self.select_scheme("unix_home")
 359         else:
 360             if self.prefix is None:
 361                 if self.exec_prefix is not None:
 362                     raise DistutilsOptionError, \
 363                           "must not supply exec-prefix without prefix"
 364
 365                 self.prefix = os.path.normpath(sys.prefix)
 366                 self.exec_prefix = os.path.normpath(sys.exec_prefix)
 367
 368             else:
 369                 if self.exec_prefix is None:
 370                     self.exec_prefix = self.prefix
 371
 372             self.install_base = self.prefix
 373             self.install_platbase = self.exec_prefix
 374             self.select_scheme("unix_prefix")
 375
 376     # finalize_unix ()
 377
 378
 379     def finalize_other (self):          # Windows and Mac OS for now
 380
 381         if self.prefix is None:
 382             self.prefix = os.path.normpath(sys.prefix)
 383
 384         self.install_base = self.install_platbase = self.prefix
 385         try:
 386             self.select_scheme(os.name)
 387         except KeyError:
 388             raise DistutilsPlatformError, \
 389                   "I don't know how to install stuff on '%s'" % os.name
 390
 391     # finalize_other ()
 392
 393
 394     def select_scheme (self, name):
 395         # it's the caller's problem if they supply a bad name!
 396         scheme = INSTALL_SCHEMES[name]
 397         for key in SCHEME_KEYS:
 398             attrname = 'install_' + key
 399             if getattr(self, attrname) is None:
 400                 setattr(self, attrname, scheme[key])
 401
 402
 403     def _expand_attrs (self, attrs):
 404         for attr in attrs:
 405             val = getattr(self, attr)
 406             if val is not None:
 407                 if os.name == 'posix':
 408                     val = os.path.expanduser(val)
 409                 val = subst_vars(val, self.config_vars)
 410                 setattr(self, attr, val)
 411
 412
 413     def expand_basedirs (self):
 414         self._expand_attrs(['install_base',
 415                             'install_platbase',
 416                             'root'])
 417
 418     def expand_dirs (self):
 419         self._expand_attrs(['install_purelib',
 420                             'install_platlib',
 421                             'install_lib',
 422                             'install_headers',
 423                             'install_scripts',
 424                             'install_data',])
 425
 426
 427     def convert_paths (self, *names):
 428         for name in names:
 429             attr = "install_" + name
 430             setattr(self, attr, convert_path(getattr(self, attr)))
 431
 432
 433     def handle_extra_path (self):
 434
 435         if self.extra_path is None:
 436             self.extra_path = self.distribution.extra_path
 437
 438         if self.extra_path is not None:
 439             if type(self.extra_path) is StringType:
 440                 self.extra_path = string.split(self.extra_path, ',')
 441
 442             if len(self.extra_path) == 1:
 443                 path_file = extra_dirs = self.extra_path[0]
 444             elif len(self.extra_path) == 2:
 445                 (path_file, extra_dirs) = self.extra_path
 446             else:
 447                 raise DistutilsOptionError, \
 448                       "'extra_path' option must be a list, tuple, or " + \
 449                       "comma-separated string with 1 or 2 elements"
 450
 451             # convert to local form in case Unix notation used (as it
 452             # should be in setup scripts)
 453             extra_dirs = convert_path(extra_dirs)
 454
 455         else:
 456             path_file = None
 457             extra_dirs = ''
 458
 459         # XXX should we warn if path_file and not extra_dirs? (in which
 460         # case the path file would be harmless but pointless)
 461         self.path_file = path_file
 462         self.extra_dirs = extra_dirs
 463
 464     # handle_extra_path ()
 465
 466
 467     def change_roots (self, *names):
 468         for name in names:
 469             attr = "install_" + name
 470             setattr(self, attr, change_root(self.root, getattr(self, attr)))
 471
 472
 473     # -- Command execution methods -------------------------------------
 474
 475     def run (self):
 476
 477         # Obviously have to build before we can install
 478         if not self.skip_build:
 479             self.run_command('build')
 480
 481         # Run all sub-commands (at least those that need to be run)
 482         for cmd_name in self.get_sub_commands():
 483             self.run_command(cmd_name)
 484
 485         if self.path_file:
 486             self.create_path_file()
 487
 488         # write list of installed files, if requested.
 489         if self.record:
 490             outputs = self.get_outputs()
 491             if self.root:               # strip any package prefix
 492                 root_len = len(self.root)
 493                 for counter in xrange(len(outputs)):
 494                     outputs[counter] = outputs[counter][root_len:]
 495             self.execute(write_file,
 496                          (self.record, outputs),
 497                          "writing list of installed files to '%s'" %
 498                          self.record)
 499
 500         sys_path = map(os.path.normpath, sys.path)
 501         sys_path = map(os.path.normcase, sys_path)
 502         install_lib = os.path.normcase(os.path.normpath(self.install_lib))
 503         if (self.warn_dir and
 504             not (self.path_file and self.install_path_file) and
 505             install_lib not in sys_path):
 506             self.warn(("modules installed to '%s', which is not in " +
 507                        "Python's module search path (sys.path) -- " +
 508                        "you'll have to change the search path yourself") %
 509                       self.install_lib)
 510
 511     # run ()
 512
 513     def create_path_file (self):
 514         filename = os.path.join(self.install_libbase,
 515                                 self.path_file + ".pth")
 516         if self.install_path_file:
 517             self.execute(write_file,
 518                          (filename, [self.extra_dirs]),
 519                          "creating %s" % filename)
 520         else:
 521             self.warn("path file '%s' not created" % filename)
 522
 523
 524     # -- Reporting methods ---------------------------------------------
 525
 526     def get_outputs (self):
 527         # This command doesn't have any outputs of its own, so just
 528         # get the outputs of all its sub-commands.
 529         outputs = []
 530         for cmd_name in self.get_sub_commands():
 531             cmd = self.get_finalized_command(cmd_name)
 532             outputs.extend(cmd.get_outputs())
 533
 534         return outputs
 535
 536     def get_inputs (self):
 537         # XXX gee, this looks familiar ;-(
 538         inputs = []
 539         for cmd_name in self.get_sub_commands():
 540             cmd = self.get_finalized_command(cmd_name)
 541             inputs.extend(cmd.get_inputs())
 542
 543         return inputs
 544
 545
 546     # -- Predicates for sub-command list -------------------------------
 547
 548     def has_lib (self):
 549         """Return true if the current distribution has any Python
 550         modules to install."""
 551         return (self.distribution.has_pure_modules() or
 552                 self.distribution.has_ext_modules())
 553
 554     def has_headers (self):
 555         return self.distribution.has_headers()
 556
 557     def has_scripts (self):
 558         return self.distribution.has_scripts()
 559
 560     def has_data (self):
 561         return self.distribution.has_data_files()
 562
 563
 564     # 'sub_commands': a list of commands this command might have to run to
 565     # get its work done.  See cmd.py for more info.
 566     sub_commands = [('install_lib',     has_lib),
 567                     ('install_headers', has_headers),
 568                     ('install_scripts', has_scripts),
 569                     ('install_data',    has_data),
 570                    ]
 571
 572 # class install