blob: 54b81879a566e3a91c51d0919b697de4144eb9cd [file] [log] [blame]
"""distutils.command.install
Implements the Distutils 'install' command."""
# created 1999/03/13, Greg Ward
__rcsid__ = "$Id$"
import sys, os, string
from distutils import sysconfig
from distutils.core import Command
class Install (Command):
options = [('prefix=', None, "installation prefix"),
('execprefix=', None,
"prefix for platform-specific files"),
# Build directories: where to install from
('build-base=', None,
"base build directory"),
('build-lib=', None,
"build directory for non-platform-specific library files"),
('build-platlib=', None,
"build directory for platform-specific library files"),
# Installation directories: where to put modules and packages
('install-lib=', None,
"base Python library directory"),
('install-platlib=', None,
"platform-specific Python library directory"),
('install-site-lib=', None,
"directory for site-specific packages and modules"),
('install-site-platlib=', None,
"platform-specific site directory"),
('install-scheme=', None,
"install to 'system' or 'site' library directory?"),
# Where to install documentation (eventually!)
('doc-format=', None, "format of documentation to generate"),
('install-man=', None, "directory for Unix man pages"),
('install-html=', None, "directory for HTML documentation"),
('install-info=', None, "directory for GNU info files"),
# Flags for 'build_py'
('compile-py', None, "compile .py to .pyc"),
('optimize-py', None, "compile .py to .pyo (optimized)"),
]
def set_default_options (self):
self.build_base = None
self.build_lib = None
self.build_platlib = None
# Don't define 'prefix' or 'exec_prefix' so we can know when the
# command is run whether the user supplied values
self.prefix = None
self.exec_prefix = None
# These two, we can supply real values for! (because they're
# not directories, and don't have a confusing multitude of
# possible derivations)
#self.install_scheme = 'site'
self.doc_format = None
# The actual installation directories are determined only at
# run-time, so the user can supply just prefix (and exec_prefix?)
# as a base for everything else
self.install_lib = None
self.install_platlib = None
self.install_site_lib = None
self.install_site_platlib = None
self.install_man = None
self.install_html = None
self.install_info = None
self.compile_py = 1
self.optimize_py = 1
def set_final_options (self):
# XXX this method is where the default installation directories
# for modules and extension modules are determined. (Someday,
# the default installation directories for scripts,
# documentation, and whatever else the Distutils can build and
# install will also be determined here.) Thus, this is a pretty
# important place to fiddle with for anyone interested in
# installation schemes for the Python library. Issues that
# are not yet resolved to my satisfaction:
# * how much platform dependence should be here, and
# how much can be pushed off to sysconfig (or, better, the
# Makefiles parsed by sysconfig)?
# * how independent of Python version should this be -- ie.
# should we have special cases to handle Python 1.5 and
# older, and then do it "the right way" for 1.6? Or should
# we install a site.py along with Distutils under pre-1.6
# Python to take care of the current deficiencies in
# Python's library installation scheme?
#
# Currently, this method has hacks to distinguish POSIX from
# non-POSIX systems (for installation of site-local modules),
# and assumes the Python 1.5 installation tree with no site.py
# to fix things.
# Figure out the build directories, ie. where to install from
self.set_peer_option ('build', 'basedir', self.build_base)
self.set_undefined_options ('build',
('basedir', 'build_base'),
('libdir', 'build_lib'),
('platdir', 'build_platlib'))
# Figure out actual installation directories; the basic principle
# is: if the user supplied nothing, then use the directories that
# Python was built and installed with (ie. the compiled-in prefix
# and exec_prefix, and the actual installation directories gleaned
# by sysconfig). If the user supplied a prefix (and possibly
# exec_prefix), then we generate our own installation directories,
# following any pattern gleaned from sysconfig's findings. If no
# such pattern can be gleaned, then we'll just make do and try to
# ape the behaviour of Python's configure script.
if self.prefix is None: # user didn't override
self.prefix = sys.prefix
if self.exec_prefix is None:
self.exec_prefix = sys.exec_prefix
if self.install_lib is None:
self.install_lib = \
self.replace_sys_prefix ('LIBDEST', ('lib','python1.5'))
if self.install_platlib is None:
# XXX this should probably be DESTSHARED -- but why is there no
# equivalent to DESTSHARED for the "site-packages" dir"?
self.install_platlib = \
self.replace_sys_prefix ('BINLIBDEST', ('lib','python1.5'), 1)
# Here is where we decide where to install most library files:
# on POSIX systems, they go to 'site-packages' under the
# install_lib (determined above -- typically
# /usr/local/lib/python1.x). Unfortunately, both
# platform-independent (.py*) and platform-specific (.so) files
# go to this directory, since there is no site-packages under
# $exec_prefix in the usual way that Python builds sys.path. On
# non-POSIX systems, the situation is even worse: everything
# gets dumped right into $exec_prefix, not even a lib
# subdirectory! But apparently that's what needs to be done to
# make it work under Python 1.5 -- hope we can get this fixed
# for 1.6!
if self.install_site_lib is None:
if os.name == 'posix':
self.install_site_lib = \
os.path.join (self.install_lib, 'site-packages')
else:
self.install_site_lib = self.exec_prefix
if self.install_site_platlib is None:
if os.name == 'posix':
# XXX ugh! this puts platform-specific files in with
# shared files, with no nice way to override it! (this
# might be a Python problem, though, not a Distutils
# problem...)
self.install_site_platlib = \
os.path.join (self.install_lib, 'site-packages')
else:
self.install_site_platlib = self.exec_prefix
#if self.install_scheme == 'site':
# install_lib = self.install_site_lib
# install_platlib = self.install_site_platlib
#elif self.install_scheme == 'system':
# install_lib = self.install_lib
# install_platlib = self.install_platlib
#else:
# # XXX new exception for this kind of misbehaviour?
# raise DistutilsArgError, \
# "invalid install scheme '%s'" % self.install_scheme
# Punt on doc directories for now -- after all, we're punting on
# documentation completely!
# set_final_options ()
def replace_sys_prefix (self, config_attr, fallback_postfix, use_exec=0):
"""Attempts to glean a simple pattern from an installation
directory available as a 'sysconfig' attribute: if the
directory name starts with the "system prefix" (the one
hard-coded in the Makefile and compiled into Python),
then replace it with the current installation prefix and
return the "relocated" installation directory."""
if use_exec:
sys_prefix = sys.exec_prefix
my_prefix = self.exec_prefix
else:
sys_prefix = sys.prefix
my_prefix = self.prefix
val = getattr (sysconfig, config_attr)
if string.find (val, sys_prefix) == 0:
# If the sysconfig directory starts with the system prefix,
# then we can "relocate" it to the user-supplied prefix --
# assuming, of course, it is different from the system prefix.
if sys_prefix == my_prefix:
return val
else:
return my_prefix + val[len(sys_prefix):]
else:
# Otherwise, just tack the "fallback postfix" onto the
# user-specified prefix.
return apply (os.join, (my_prefix,) + fallback_postfix)
# replace_sys_prefix ()
def run (self):
self.set_final_options ()
# Obviously have to build before we can install
self.run_peer ('build')
# Install modules in two steps: "platform-shared" files (ie. pure
# python modules) and platform-specific files (compiled C
# extensions).
self.run_peer ('install_py')
# don't have an 'install_ext' command just yet!
#self.run_peer ('install_ext'))
# run ()
# class Install