Abstract base class for defining command classes, the "worker
bees" of the Distutils. A useful analogy for command classes is to
think of them as subroutines with local variables called
"options". The options are "declared" in
'initialize_options()' and "defined" (given their final values,
aka "finalized") in 'finalize_options()', both of which must be
defined by every command class. The distinction between the two is
necessary because option values might come from the outside world
(command line, config file, ...), and any options dependent on other
options must be computed *after* these outside influences have been
processed -- hence 'finalize_options()'. The "body" of the
subroutine, where it does all its work based on the values of its
options, is the 'run()' method, which must also be implemented by every
command class.
|
|
|
__init__(self,
dist)
Create and initialize a new Command object. |
|
|
|
_ensure_stringlike(self,
option,
what,
default=None) |
|
|
|
_ensure_tested_string(self,
option,
tester,
what,
error_fmt,
default=None) |
|
|
|
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. |
|
|
|
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_string(self,
option,
default=None)
Ensure that 'option' is a string; if not defined, set it to
'default'. |
|
|
|
|
|
execute(self,
func,
args,
msg=None,
level=1) |
|
|
|
finalize_options(self)
Set final values for all the options that this command supports. |
|
|
|
|
|
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). |
|
|
|
initialize_options(self)
Set default values for all the options that this command supports. |
|
|
|
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. |
|
|
|
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) |
|
|
|
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()'. |
|
|
|
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=1,
level=1)
Spawn an external command respecting dry-run flag. |
|
|
|
|