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

Class clean

Command --+
          |
         clean


Method Summary
  finalize_options(self)
Set final values for all the options that this command supports.
  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()'.

Class Variable Summary
list boolean_options = ['all']
str description = "clean up output of 'build' command"
list user_options = [('build-base=', 'b', "base build directo...

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:
['all']                                                                

description

Type:
str
Value:
"clean up output of 'build' command"                                   

user_options

Type:
list
Value:
[('build-base=', 'b', "base build directory (default: 'build.build-bas\
e')"),
 ('build-lib=',
  None,
  "build directory for all modules (default: 'build.build-lib')"),
 ('build-temp=',
  't',
  "temporary build directory (default: 'build.build-temp')"),
...                                                                    

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:08:02 2007 http://epydoc.sf.net