Package distutils :: Package command :: Module build_clib :: Class build_clib

_ClassType build_clib

cmd.Command --+
              |
             build_clib

Instance Methods

[hide private]

initialize_options(self)
Set default values for all the options that this command supports.

finalize_options(self)
Set final 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()'.

check_library_list(self, libraries)
Ensure that the list of libraries (presumably provided as a command option 'libraries') is valid, i.e.

get_library_names(self)

get_source_files(self)

build_libraries(self, libraries)

Inherited from cmd.Command: __getattr__, __init__, announce, copy_file, copy_tree, debug_print, dump_options, ensure_dirname, ensure_filename, ensure_finalized, ensure_string, ensure_string_list, execute, get_command_name, get_finalized_command, get_sub_commands, make_archive, make_file, mkpath, move_file, reinitialize_command, run_command, set_undefined_options, spawn, warn

Inherited from cmd.Command (private): _ensure_stringlike, _ensure_tested_string

Class Variables

[hide private]

description = 'build C/C++ libraries used by Python extensions'

user_options = [('build-clib', 'b', 'directory to build C/C++ ...

boolean_options = ['debug', 'force']

help_options = [('help-compiler', None, 'list available compil...

Inherited from cmd.Command: sub_commands

Method Details

[hide private]

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: cmd.Command.initialize_options: (inherited documentation)

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: cmd.Command.finalize_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: cmd.Command.run: (inherited documentation)

check_library_list(self, libraries)

Ensure that the list of libraries (presumably provided as a command option 'libraries') is valid, i.e. it is a list of 2-tuples, where the tuples are (library_name, build_info_dict). Raise DistutilsSetupError if the structure is invalid anywhere; just returns otherwise.

Class Variable Details

[hide private]

user_options

Value:

[('build-clib', 'b', 'directory to build C/C++ libraries to'),
 ('build-temp', 't', 'directory to put temporary build by-products'),
 ('debug', 'g', 'compile with debugging information'),
 ('force', 'f', 'forcibly build everything (ignore file timestamps)'),
 ('compiler=', 'c', 'specify the compiler type')]

help_options

Value:

[('help-compiler',
  None,
  'list available compilers',
  <function show_compilers at 0x41250b54>)]