1 """distutils.command.install

     2 

     3 Implements the Distutils 'install' command."""

     4 

     5 from distutils import log

     6 

     7 # This module should be kept compatible with Python 2.1.

     8 

     9 __revision__ = "$Id: install.py 43363 2006-03-27 21:55:21Z phillip.eby $"

    10 

    11 import sys, os, string

    12 from types import *

    13 from distutils.core import Command

    14 from distutils.debug import DEBUG

    15 from distutils.sysconfig import get_config_vars

    16 from distutils.errors import DistutilsPlatformError

    17 from distutils.file_util import write_file

    18 from distutils.util import convert_path, subst_vars, change_root

    19 from distutils.errors import DistutilsOptionError

    20 from glob import glob

    21 

    22 if sys.version < "2.2":

    23     WINDOWS_SCHEME = {

    24         'purelib': '$base',

    25         'platlib': '$base',

    26         'headers': '$base/Include/$dist_name',

    27         'scripts': '$base/Scripts',

    28         'data'   : '$base',

    29     }

    30 else:

    31     WINDOWS_SCHEME = {

    32         'purelib': '$base/Lib/site-packages',

    33         'platlib': '$base/Lib/site-packages',

    34         'headers': '$base/Include/$dist_name',

    35         'scripts': '$base/Scripts',

    36         'data'   : '$base',

    37     }

    38 

    39 INSTALL_SCHEMES = {

    40     'unix_prefix': {

    41         'purelib': '$base/lib/python$py_version_short/site-packages',

    42         'platlib': '$platbase/lib/python$py_version_short/site-packages',

    43         'headers': '$base/include/python$py_version_short/$dist_name',

    44         'scripts': '$base/bin',

    45         'data'   : '$base',

    46         },

    47     'unix_home': {

    48         'purelib': '$base/lib/python',

    49         'platlib': '$base/lib/python',

    50         'headers': '$base/include/python/$dist_name',

    51         'scripts': '$base/bin',

    52         'data'   : '$base',

    53         },

    54     'nt': WINDOWS_SCHEME,

    55     'mac': {

    56         'purelib': '$base/Lib/site-packages',

    57         'platlib': '$base/Lib/site-packages',

    58         'headers': '$base/Include/$dist_name',

    59         'scripts': '$base/Scripts',

    60         'data'   : '$base',

    61         },

    62     'os2': {

    63         'purelib': '$base/Lib/site-packages',

    64         'platlib': '$base/Lib/site-packages',

    65         'headers': '$base/Include/$dist_name',

    66         'scripts': '$base/Scripts',

    67         'data'   : '$base',

    68         }

    69     }

    70 

    71 # The keys to an installation scheme; if any new types of files are to be

    72 # installed, be sure to add an entry to every installation scheme above,

    73 # and to SCHEME_KEYS here.

    74 SCHEME_KEYS = ('purelib', 'platlib', 'headers', 'scripts', 'data')

    75 

    76 

    77 class install (Command):

    78 

    79     description = "install everything from build directory"

    80 

    81     user_options = [

    82         # Select installation scheme and set base director(y|ies)

    83         ('prefix=', None,

    84          "installation prefix"),

    85         ('exec-prefix=', None,

    86          "(Unix only) prefix for platform-specific files"),

    87         ('home=', None,

    88          "(Unix only) home directory to install under"),

    89 

    90         # Or, just set the base director(y|ies)

    91         ('install-base=', None,

    92          "base installation directory (instead of --prefix or --home)"),

    93         ('install-platbase=', None,

    94          "base installation directory for platform-specific files " +

    95          "(instead of --exec-prefix or --home)"),

    96         ('root=', None,

    97          "install everything relative to this alternate root directory"),

    98 

    99         # Or, explicitly set the installation scheme

   100         ('install-purelib=', None,

   101          "installation directory for pure Python module distributions"),

   102         ('install-platlib=', None,

   103          "installation directory for non-pure module distributions"),

   104         ('install-lib=', None,

   105          "installation directory for all module distributions " +

   106          "(overrides --install-purelib and --install-platlib)"),

   107 

   108         ('install-headers=', None,

   109          "installation directory for C/C++ headers"),

   110         ('install-scripts=', None,

   111          "installation directory for Python scripts"),

   112         ('install-data=', None,

   113          "installation directory for data files"),

   114 

   115         # Byte-compilation options -- see install_lib.py for details, as

   116         # these are duplicated from there (but only install_lib does

   117         # anything with them).

   118         ('compile', 'c', "compile .py to .pyc [default]"),

   119         ('no-compile', None, "don't compile .py files"),

   120         ('optimize=', 'O',

   121          "also compile with optimization: -O1 for \"python -O\", "

   122          "-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),

   123 

   124         # Miscellaneous control options

   125         ('force', 'f',

   126          "force installation (overwrite any existing files)"),

   127         ('skip-build', None,

   128          "skip rebuilding everything (for testing/debugging)"),

   129 

   130         # Where to install documentation (eventually!)

   131         #('doc-format=', None, "format of documentation to generate"),

   132         #('install-man=', None, "directory for Unix man pages"),

   133         #('install-html=', None, "directory for HTML documentation"),

   134         #('install-info=', None, "directory for GNU info files"),

   135 

   136         ('record=', None,

   137          "filename in which to record list of installed files"),

   138         ]

   139 

   140     boolean_options = ['compile', 'force', 'skip-build']

   141     negative_opt = {'no-compile' : 'compile'}

   142 

   143 

   144     def initialize_options (self):

   145 

   146         # High-level options: these select both an installation base

   147         # and scheme.

   148         self.prefix = None

   149         self.exec_prefix = None

   150         self.home = None

   151 

   152         # These select only the installation base; it's up to the user to

   153         # specify the installation scheme (currently, that means supplying

   154         # the --install-{platlib,purelib,scripts,data} options).

   155         self.install_base = None

   156         self.install_platbase = None

   157         self.root = None

   158 

   159         # These options are the actual installation directories; if not

   160         # supplied by the user, they are filled in using the installation

   161         # scheme implied by prefix/exec-prefix/home and the contents of

   162         # that installation scheme.

   163         self.install_purelib = None     # for pure module distributions

   164         self.install_platlib = None     # non-pure (dists w/ extensions)

   165         self.install_headers = None     # for C/C++ headers

   166         self.install_lib = None         # set to either purelib or platlib

   167         self.install_scripts = None

   168         self.install_data = None

   169 

   170         self.compile = None

   171         self.optimize = None

   172 

   173         # These two are for putting non-packagized distributions into their

   174         # own directory and creating a .pth file if it makes sense.

   175         # 'extra_path' comes from the setup file; 'install_path_file' can

   176         # be turned off if it makes no sense to install a .pth file.  (But

   177         # better to install it uselessly than to guess wrong and not

   178         # install it when it's necessary and would be used!)  Currently,

   179         # 'install_path_file' is always true unless some outsider meddles

   180         # with it.

   181         self.extra_path = None

   182         self.install_path_file = 1

   183 

   184         # 'force' forces installation, even if target files are not

   185         # out-of-date.  'skip_build' skips running the "build" command,

   186         # handy if you know it's not necessary.  'warn_dir' (which is *not*

   187         # a user option, it's just there so the bdist_* commands can turn

   188         # it off) determines whether we warn about installing to a

   189         # directory not in sys.path.

   190         self.force = 0

   191         self.skip_build = 0

   192         self.warn_dir = 1

   193 

   194         # These are only here as a conduit from the 'build' command to the

   195         # 'install_*' commands that do the real work.  ('build_base' isn't

   196         # actually used anywhere, but it might be useful in future.)  They

   197         # are not user options, because if the user told the install

   198         # command where the build directory is, that wouldn't affect the

   199         # build command.

   200         self.build_base = None

   201         self.build_lib = None

   202 

   203         # Not defined yet because we don't know anything about

   204         # documentation yet.

   205         #self.install_man = None

   206         #self.install_html = None

   207         #self.install_info = None

   208 

   209         self.record = None

   210 

   211 

   212     # -- Option finalizing methods -------------------------------------

   213     # (This is rather more involved than for most commands,

   214     # because this is where the policy for installing third-

   215     # party Python modules on various platforms given a wide

   216     # array of user input is decided.  Yes, it's quite complex!)

   217 

   218     def finalize_options (self):

   219 

   220         # This method (and its pliant slaves, like 'finalize_unix()',

   221         # 'finalize_other()', and 'select_scheme()') is where the default

   222         # installation directories for modules, extension modules, and

   223         # anything else we care to install from a Python module

   224         # distribution.  Thus, this code makes a pretty important policy

   225         # statement about how third-party stuff is added to a Python

   226         # installation!  Note that the actual work of installation is done

   227         # by the relatively simple 'install_*' commands; they just take

   228         # their orders from the installation directory options determined

   229         # here.

   230 

   231         # Check for errors/inconsistencies in the options; first, stuff

   232         # that's wrong on any platform.

   233 

   234         if ((self.prefix or self.exec_prefix or self.home) and

   235             (self.install_base or self.install_platbase)):

   236             raise DistutilsOptionError, \

   237                   ("must supply either prefix/exec-prefix/home or " +

   238                    "install-base/install-platbase -- not both")

   239 

   240         if self.home and (self.prefix or self.exec_prefix):

   241             raise DistutilsOptionError, \

   242                   "must supply either home or prefix/exec-prefix -- not both"

   243 

   244         # Next, stuff that's wrong (or dubious) only on certain platforms.

   245         if os.name != "posix":

   246             if self.exec_prefix:

   247                 self.warn("exec-prefix option ignored on this platform")

   248                 self.exec_prefix = None

   249 

   250         # Now the interesting logic -- so interesting that we farm it out

   251         # to other methods.  The goal of these methods is to set the final

   252         # values for the install_{lib,scripts,data,...}  options, using as

   253         # input a heady brew of prefix, exec_prefix, home, install_base,

   254         # install_platbase, user-supplied versions of

   255         # install_{purelib,platlib,lib,scripts,data,...}, and the

   256         # INSTALL_SCHEME dictionary above.  Phew!

   257 

   258         self.dump_dirs("pre-finalize_{unix,other}")

   259 

   260         if os.name == 'posix':

   261             self.finalize_unix()

   262         else:

   263             self.finalize_other()

   264 

   265         self.dump_dirs("post-finalize_{unix,other}()")

   266 

   267         # Expand configuration variables, tilde, etc. in self.install_base

   268         # and self.install_platbase -- that way, we can use $base or

   269         # $platbase in the other installation directories and not worry

   270         # about needing recursive variable expansion (shudder).

   271 

   272         py_version = (string.split(sys.version))[0]

   273         (prefix, exec_prefix) = get_config_vars('prefix', 'exec_prefix')

   274         self.config_vars = {'dist_name': self.distribution.get_name(),

   275                             'dist_version': self.distribution.get_version(),

   276                             'dist_fullname': self.distribution.get_fullname(),

   277                             'py_version': py_version,

   278                             'py_version_short': py_version[0:3],

   279                             'sys_prefix': prefix,

   280                             'prefix': prefix,

   281                             'sys_exec_prefix': exec_prefix,

   282                             'exec_prefix': exec_prefix,

   283                            }

   284         self.expand_basedirs()

   285 

   286         self.dump_dirs("post-expand_basedirs()")

   287 

   288         # Now define config vars for the base directories so we can expand

   289         # everything else.

   290         self.config_vars['base'] = self.install_base

   291         self.config_vars['platbase'] = self.install_platbase

   292 

   293         if DEBUG:

   294             from pprint import pprint

   295             print "config vars:"

   296             pprint(self.config_vars)

   297 

   298         # Expand "~" and configuration variables in the installation

   299         # directories.

   300         self.expand_dirs()

   301 

   302         self.dump_dirs("post-expand_dirs()")

   303 

   304         # Pick the actual directory to install all modules to: either

   305         # install_purelib or install_platlib, depending on whether this

   306         # module distribution is pure or not.  Of course, if the user

   307         # already specified install_lib, use their selection.

   308         if self.install_lib is None:

   309             if self.distribution.ext_modules: # has extensions: non-pure

   310                 self.install_lib = self.install_platlib

   311             else:

   312                 self.install_lib = self.install_purelib

   313 

   314 

   315         # Convert directories from Unix /-separated syntax to the local

   316         # convention.

   317         self.convert_paths('lib', 'purelib', 'platlib',

   318                            'scripts', 'data', 'headers')

   319 

   320         # Well, we're not actually fully completely finalized yet: we still

   321         # have to deal with 'extra_path', which is the hack for allowing

   322         # non-packagized module distributions (hello, Numerical Python!) to

   323         # get their own directories.

   324         self.handle_extra_path()

   325         self.install_libbase = self.install_lib # needed for .pth file

   326         self.install_lib = os.path.join(self.install_lib, self.extra_dirs)

   327 

   328         # If a new root directory was supplied, make all the installation

   329         # dirs relative to it.

   330         if self.root is not None:

   331             self.change_roots('libbase', 'lib', 'purelib', 'platlib',

   332                               'scripts', 'data', 'headers')

   333 

   334         self.dump_dirs("after prepending root")

   335 

   336         # Find out the build directories, ie. where to install from.

   337         self.set_undefined_options('build',

   338                                    ('build_base', 'build_base'),

   339                                    ('build_lib', 'build_lib'))

   340 

   341         # Punt on doc directories for now -- after all, we're punting on

   342         # documentation completely!

   343 

   344     # finalize_options ()

   345 

   346 

   347     def dump_dirs (self, msg):

   348         if DEBUG:

   349             from distutils.fancy_getopt import longopt_xlate

   350             print msg + ":"

   351             for opt in self.user_options:

   352                 opt_name = opt[0]

   353                 if opt_name[-1] == "=":

   354                     opt_name = opt_name[0:-1]

   355                 if self.negative_opt.has_key(opt_name):

   356                     opt_name = string.translate(self.negative_opt[opt_name],

   357                                                 longopt_xlate)

   358                     val = not getattr(self, opt_name)

   359                 else:

   360                     opt_name = string.translate(opt_name, longopt_xlate)

   361                     val = getattr(self, opt_name)

   362                 print "  %s: %s" % (opt_name, val)

   363 

   364 

   365     def finalize_unix (self):

   366 

   367         if self.install_base is not None or self.install_platbase is not None:

   368             if ((self.install_lib is None and

   369                  self.install_purelib is None and

   370                  self.install_platlib is None) or

   371                 self.install_headers is None or

   372                 self.install_scripts is None or

   373                 self.install_data is None):

   374                 raise DistutilsOptionError, \

   375                       ("install-base or install-platbase supplied, but "

   376                       "installation scheme is incomplete")

   377             return

   378 

   379         if self.home is not None:

   380             self.install_base = self.install_platbase = self.home

   381             self.select_scheme("unix_home")

   382         else:

   383             if self.prefix is None:

   384                 if self.exec_prefix is not None:

   385                     raise DistutilsOptionError, \

   386                           "must not supply exec-prefix without prefix"

   387 

   388                 self.prefix = os.path.normpath(sys.prefix)

   389                 self.exec_prefix = os.path.normpath(sys.exec_prefix)

   390 

   391             else:

   392                 if self.exec_prefix is None:

   393                     self.exec_prefix = self.prefix

   394 

   395             self.install_base = self.prefix

   396             self.install_platbase = self.exec_prefix

   397             self.select_scheme("unix_prefix")

   398 

   399     # finalize_unix ()

   400 

   401 

   402     def finalize_other (self):          # Windows and Mac OS for now

   403 

   404         if self.home is not None:

   405             self.install_base = self.install_platbase = self.home

   406             self.select_scheme("unix_home")

   407         else:

   408             if self.prefix is None:

   409                 self.prefix = os.path.normpath(sys.prefix)

   410 

   411             self.install_base = self.install_platbase = self.prefix

   412             try:

   413                 self.select_scheme(os.name)

   414             except KeyError:

   415                 raise DistutilsPlatformError, \

   416                       "I don't know how to install stuff on '%s'" % os.name

   417 

   418     # finalize_other ()

   419 

   420 

   421     def select_scheme (self, name):

   422         # it's the caller's problem if they supply a bad name!

   423         scheme = INSTALL_SCHEMES[name]

   424         for key in SCHEME_KEYS:

   425             attrname = 'install_' + key

   426             if getattr(self, attrname) is None:

   427                 setattr(self, attrname, scheme[key])

   428 

   429 

   430     def _expand_attrs (self, attrs):

   431         for attr in attrs:

   432             val = getattr(self, attr)

   433             if val is not None:

   434                 if os.name == 'posix':

   435                     val = os.path.expanduser(val)

   436                 val = subst_vars(val, self.config_vars)

   437                 setattr(self, attr, val)

   438 

   439 

   440     def expand_basedirs (self):

   441         self._expand_attrs(['install_base',

   442                             'install_platbase',

   443                             'root'])

   444 

   445     def expand_dirs (self):

   446         self._expand_attrs(['install_purelib',

   447                             'install_platlib',

   448                             'install_lib',

   449                             'install_headers',

   450                             'install_scripts',

   451                             'install_data',])

   452 

   453 

   454     def convert_paths (self, *names):

   455         for name in names:

   456             attr = "install_" + name

   457             setattr(self, attr, convert_path(getattr(self, attr)))

   458 

   459 

   460     def handle_extra_path (self):

   461 

   462         if self.extra_path is None:

   463             self.extra_path = self.distribution.extra_path

   464 

   465         if self.extra_path is not None:

   466             if type(self.extra_path) is StringType:

   467                 self.extra_path = string.split(self.extra_path, ',')

   468 

   469             if len(self.extra_path) == 1:

   470                 path_file = extra_dirs = self.extra_path[0]

   471             elif len(self.extra_path) == 2:

   472                 (path_file, extra_dirs) = self.extra_path

   473             else:

   474                 raise DistutilsOptionError, \

   475                       ("'extra_path' option must be a list, tuple, or "

   476                       "comma-separated string with 1 or 2 elements")

   477 

   478             # convert to local form in case Unix notation used (as it

   479             # should be in setup scripts)

   480             extra_dirs = convert_path(extra_dirs)

   481 

   482         else:

   483             path_file = None

   484             extra_dirs = ''

   485 

   486         # XXX should we warn if path_file and not extra_dirs? (in which

   487         # case the path file would be harmless but pointless)

   488         self.path_file = path_file

   489         self.extra_dirs = extra_dirs

   490 

   491     # handle_extra_path ()

   492 

   493 

   494     def change_roots (self, *names):

   495         for name in names:

   496             attr = "install_" + name

   497             setattr(self, attr, change_root(self.root, getattr(self, attr)))

   498 

   499 

   500     # -- Command execution methods -------------------------------------

   501 

   502     def run (self):

   503 

   504         # Obviously have to build before we can install

   505         if not self.skip_build:

   506             self.run_command('build')

   507 

   508         # Run all sub-commands (at least those that need to be run)

   509         for cmd_name in self.get_sub_commands():

   510             self.run_command(cmd_name)

   511 

   512         if self.path_file:

   513             self.create_path_file()

   514 

   515         # write list of installed files, if requested.

   516         if self.record:

   517             outputs = self.get_outputs()

   518             if self.root:               # strip any package prefix

   519                 root_len = len(self.root)

   520                 for counter in xrange(len(outputs)):

   521                     outputs[counter] = outputs[counter][root_len:]

   522             self.execute(write_file,

   523                          (self.record, outputs),

   524                          "writing list of installed files to '%s'" %

   525                          self.record)

   526 

   527         sys_path = map(os.path.normpath, sys.path)

   528         sys_path = map(os.path.normcase, sys_path)

   529         install_lib = os.path.normcase(os.path.normpath(self.install_lib))

   530         if (self.warn_dir and

   531             not (self.path_file and self.install_path_file) and

   532             install_lib not in sys_path):

   533             log.debug(("modules installed to '%s', which is not in "

   534                        "Python's module search path (sys.path) -- "

   535                        "you'll have to change the search path yourself"),

   536                        self.install_lib)

   537 

   538     # run ()

   539 

   540     def create_path_file (self):

   541         filename = os.path.join(self.install_libbase,

   542                                 self.path_file + ".pth")

   543         if self.install_path_file:

   544             self.execute(write_file,

   545                          (filename, [self.extra_dirs]),

   546                          "creating %s" % filename)

   547         else:

   548             self.warn("path file '%s' not created" % filename)

   549 

   550 

   551     # -- Reporting methods ---------------------------------------------

   552 

   553     def get_outputs (self):

   554         # Assemble the outputs of all the sub-commands.

   555         outputs = []

   556         for cmd_name in self.get_sub_commands():

   557             cmd = self.get_finalized_command(cmd_name)

   558             # Add the contents of cmd.get_outputs(), ensuring

   559             # that outputs doesn't contain duplicate entries

   560             for filename in cmd.get_outputs():

   561                 if filename not in outputs:

   562                     outputs.append(filename)

   563 

   564         if self.path_file and self.install_path_file:

   565             outputs.append(os.path.join(self.install_libbase,

   566                                         self.path_file + ".pth"))

   567 

   568         return outputs

   569 

   570     def get_inputs (self):

   571         # XXX gee, this looks familiar ;-(

   572         inputs = []

   573         for cmd_name in self.get_sub_commands():

   574             cmd = self.get_finalized_command(cmd_name)

   575             inputs.extend(cmd.get_inputs())

   576 

   577         return inputs

   578 

   579 

   580     # -- Predicates for sub-command list -------------------------------

   581 

   582     def has_lib (self):

   583         """Return true if the current distribution has any Python

   584         modules to install."""

   585         return (self.distribution.has_pure_modules() or

   586                 self.distribution.has_ext_modules())

   587 

   588     def has_headers (self):

   589         return self.distribution.has_headers()

   590 

   591     def has_scripts (self):

   592         return self.distribution.has_scripts()

   593 

   594     def has_data (self):

   595         return self.distribution.has_data_files()

   596 

   597 

   598     # 'sub_commands': a list of commands this command might have to run to

   599     # get its work done.  See cmd.py for more info.

   600     sub_commands = [('install_lib',     has_lib),

   601                     ('install_headers', has_headers),

   602                     ('install_scripts', has_scripts),

   603                     ('install_data',    has_data),

   604                     ('install_egg_info', lambda self:True),

   605                    ]

   606 

   607 # class install