distutils.command.install
index
/usr/local/lib/python2.5/distutils/command/install.py
Module Docs

distutils.command.install
 
Implements the Distutils 'install' command.

 
Modules
       
distutils.log
os
string
sys

 
Classes
       
distutils.cmd.Command
install

 
class install(distutils.cmd.Command)
     Methods defined here:
change_roots(self, *names)
convert_paths(self, *names)
create_path_file(self)
dump_dirs(self, msg)
expand_basedirs(self)
expand_dirs(self)
finalize_options(self)
finalize_other(self)
finalize_unix(self)
get_inputs(self)
get_outputs(self)
handle_extra_path(self)
has_data(self)
has_headers(self)
has_lib(self)
Return true if the current distribution has any Python
modules to install.
has_scripts(self)
initialize_options(self)
run(self)
select_scheme(self, name)

Data and other attributes defined here:
boolean_options = ['compile', 'force', 'skip-build']
description = 'install everything from build directory'
negative_opt = {'no-compile': 'compile'}
sub_commands = [('install_lib', <function has_lib at 0xb6b0f1b4>), ('install_headers', <function has_headers at 0xb6b0f1ec>), ('install_scripts', <function has_scripts at 0xb6b0f224>), ('install_data', <function has_data at 0xb6b0f25c>), ('install_egg_info', <function <lambda> at 0xb6b0f294>)]
user_options = [('prefix=', None, 'installation prefix'), ('exec-prefix=', None, '(Unix only) prefix for platform-specific files'), ('home=', None, '(Unix only) home directory to install under'), ('install-base=', None, 'base installation directory (instead of --prefix or --home)'), ('install-platbase=', None, 'base installation directory for platform-specific files (instead of --exec-prefix or --home)'), ('root=', None, 'install everything relative to this alternate root directory'), ('install-purelib=', None, 'installation directory for pure Python module distributions'), ('install-platlib=', None, 'installation directory for non-pure module distributions'), ('install-lib=', None, 'installation directory for all module distributi...verrides --install-purelib and --install-platlib)'), ('install-headers=', None, 'installation directory for C/C++ headers'), ('install-scripts=', None, 'installation directory for Python scripts'), ('install-data=', None, 'installation directory for data files'), ('compile', 'c', 'compile .py to .pyc [default]'), ('no-compile', None, "don't compile .py files"), ('optimize=', 'O', 'also compile with optimization: -O1 for "python ...r "python -OO", and -O0 to disable [default: -O0]'), ('force', 'f', 'force installation (overwrite any existing files)'), ('skip-build', None, 'skip rebuilding everything (for testing/debugging)'), ('record=', None, 'filename in which to record list of installed files')]

Methods inherited from distutils.cmd.Command:
__getattr__(self, attr)
__init__(self, dist)
Create and initialize a new Command object.  Most importantly,
invokes the 'initialize_options()' method, which is the real
initializer and depends on the actual command being
instantiated.
announce(self, msg, level=1)
If the current verbosity level is of greater than or equal to
'level' print 'msg' to stdout.
copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1)
Copy a file respecting verbose, dry-run and force flags.  (The
former two default to whatever is in the Distribution object, and
the latter defaults to false for commands that don't define it.)
copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1)
Copy an entire directory tree respecting verbose, dry-run,
and force flags.
debug_print(self, msg)
Print 'msg' to stdout if the global DEBUG (taken from the
DISTUTILS_DEBUG environment variable) flag is true.
dump_options(self, header=None, indent='')
ensure_dirname(self, option)
ensure_filename(self, option)
Ensure that 'option' is the name of an existing file.
ensure_finalized(self)
ensure_string(self, option, default=None)
Ensure that 'option' is a string; if not defined, set it to
'default'.
ensure_string_list(self, option)
Ensure that 'option' is a list of strings.  If 'option' is
currently a string, we split it either on /,\s*/ or /\s+/, so
"foo bar baz", "foo,bar,baz", and "foo,   bar baz" all become
["foo", "bar", "baz"].
execute(self, func, args, msg=None, level=1)
get_command_name(self)
get_finalized_command(self, command, create=1)
Wrapper around Distribution's 'get_command_obj()' method: find
(create if necessary and 'create' is true) the command object for
'command', call its 'ensure_finalized()' method, and return the
finalized command object.
get_sub_commands(self)
Determine the sub-commands that are relevant in the current
distribution (ie., that need to be run).  This is based on the
'sub_commands' class attribute: each tuple in that list may include
a method that we call to determine if the subcommand needs to be
run for the current distribution.  Return a list of command names.
make_archive(self, base_name, format, root_dir=None, base_dir=None)
make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1)
Special case of 'execute()' for operations that process one or
more input files and generate one output file.  Works just like
'execute()', except the operation is skipped and a different
message printed if 'outfile' already exists and is newer than all
files listed in 'infiles'.  If the command defined 'self.force',
and it is true, then the command is unconditionally run -- does no
timestamp checks.
mkpath(self, name, mode=511)
move_file(self, src, dst, level=1)
Move a file respectin dry-run flag.
reinitialize_command(self, command, reinit_subcommands=0)
# XXX rename to 'get_reinitialized_command()'? (should do the
# same in dist.py, if so)
run_command(self, command)
Run some other command: uses the 'run_command()' method of
Distribution, which creates and finalizes the command object if
necessary and then invokes its 'run()' method.
set_undefined_options(self, src_cmd, *option_pairs)
Set the values of any "undefined" options from corresponding
option values in some other command object.  "Undefined" here means
"is None", which is the convention used to indicate that an option
has not been changed between 'initialize_options()' and
'finalize_options()'.  Usually called from 'finalize_options()' for
options that depend on some other command rather than another
option of the same command.  'src_cmd' is the other command from
which option values will be taken (a command object will be created
for it if necessary); the remaining arguments are
'(src_option,dst_option)' tuples which mean "take the value of
'src_option' in the 'src_cmd' command object, and copy it to
'dst_option' in the current command object".
spawn(self, cmd, search_path=1, level=1)
Spawn an external command respecting dry-run flag.
warn(self, msg)

 
Data
        DEBUG = None
INSTALL_SCHEMES = {'mac': {'data': '$base', 'headers': '$base/Include/$dist_name', 'platlib': '$base/Lib/site-packages', 'purelib': '$base/Lib/site-packages', 'scripts': '$base/Scripts'}, 'nt': {'data': '$base', 'headers': '$base/Include/$dist_name', 'platlib': '$base/Lib/site-packages', 'purelib': '$base/Lib/site-packages', 'scripts': '$base/Scripts'}, 'os2': {'data': '$base', 'headers': '$base/Include/$dist_name', 'platlib': '$base/Lib/site-packages', 'purelib': '$base/Lib/site-packages', 'scripts': '$base/Scripts'}, 'unix_home': {'data': '$base', 'headers': '$base/include/python/$dist_name', 'platlib': '$base/lib/python', 'purelib': '$base/lib/python', 'scripts': '$base/bin'}, 'unix_prefix': {'data': '$base', 'headers': '$base/include/python$py_version_short/$dist_name', 'platlib': '$platbase/lib/python$py_version_short/site-packages', 'purelib': '$base/lib/python$py_version_short/site-packages', 'scripts': '$base/bin'}}
SCHEME_KEYS = ('purelib', 'platlib', 'headers', 'scripts', 'data')
StringTypes = (<type 'str'>, <type 'unicode'>)
WINDOWS_SCHEME = {'data': '$base', 'headers': '$base/Include/$dist_name', 'platlib': '$base/Lib/site-packages', 'purelib': '$base/Lib/site-packages', 'scripts': '$base/Scripts'}
__revision__ = '$Id: install.py 43363 2006-03-27 21:55:21Z phillip.eby $'