Package distutils :: Package command :: Module install_headers :: Class install_headers
[frames | no frames]

Class install_headers

Command --+
          |
         install_headers


Method Summary
  finalize_options(self)
Set final values for all the options that this command supports.
  get_inputs(self)
  get_outputs(self)
  initialize_options(self)
Set default values for all the options that this command supports.
  run(self)
A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'.
    Inherited from Command
  __init__(self, dist)
Create and initialize a new Command object.
  __getattr__(self, attr)
  announce(self, msg, level)
If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.
  copy_file(self, infile, outfile, preserve_mode, preserve_times, link, level)
Copy a file respecting verbose, dry-run and force flags.
  copy_tree(self, infile, outfile, preserve_mode, preserve_times, preserve_symlinks, level)
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, 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)
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.
  execute(self, func, args, msg, level)
  get_command_name(self)
  get_finalized_command(self, command, create)
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).
  make_archive(self, base_name, format, root_dir, base_dir)
  make_file(self, infiles, outfile, func, args, exec_msg, skip_msg, level)
Special case of 'execute()' for operations that process one or more input files and generate one output file.
  mkpath(self, name, mode)
  move_file(self, src, dst, level)
Move a file respectin dry-run flag.
  reinitialize_command(self, command, reinit_subcommands)
  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.
  spawn(self, cmd, search_path, level)
Spawn an external command respecting dry-run flag.
  warn(self, msg)

Class Variable Summary
list boolean_options = ['force']
str description = 'install C/C++ header files'
list user_options = [('install-dir=', 'd', 'directory to inst...
    Inherited from Command
list sub_commands = []

Method Details

finalize_options(self)

Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if 'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as long as 'foo' still has the same value it was assigned in 'initialize_options()'.

This method must be implemented by all command classes.

Overrides:
distutils.cmd.Command.finalize_options (inherited documentation)

initialize_options(self)

Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, 'initialize_options()' implementations are just a bunch of "self.foo = None" assignments.

This method must be implemented by all command classes.

Overrides:
distutils.cmd.Command.initialize_options (inherited documentation)

run(self)

A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'. All terminal output and filesystem interaction should be done by 'run()'.

This method must be implemented by all command classes.

Overrides:
distutils.cmd.Command.run (inherited documentation)

Class Variable Details

boolean_options

Type:
list
Value:
['force']                                                              

description

Type:
str
Value:
'install C/C++ header files'                                           

user_options

Type:
list
Value:
[('install-dir=', 'd', 'directory to install header files to'),
 ('force', 'f', 'force installation (overwrite existing files)')]      

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:44:01 2007 http://epydoc.sf.net